Communication protocols in integrated systems

ABSTRACT

A system and methods comprise a touchscreen at a premises. The touchscreen includes a processor coupled to a security system at the premises. User interfaces are presented via the touchscreen. The user interfaces include a security interface that provides control of functions of the security system and access to data collected by the security system, and a network interface that provides access to network devices. A camera at the premises is coupled to the touchscreen via a plurality of interfaces. A security server at a remote location is coupled to the touchscreen via a plurality of channels and a plurality of protocols. The channels include a short message service (SMS) channel, a remote control channel, and an asynchronous event channel. The security server comprises a client interface through which remote client devices exchange data with the touchscreen and the security system.

RELATED APPLICATIONS

This application claims the benefit of U.S. Patent Application No.61/782,345, filed Mar. 14, 2013.

This application claims the benefit of U.S. Patent Application No.61/802,077, filed Mar. 15, 2013.

This application claims the benefit of U.S. Patent Application No.61/777,061, filed Mar. 12, 2013.

This application claims the benefit of U.S. Patent Application No.61/778,853, filed Mar. 13, 2013.

This application claims the benefit of U.S. Patent Application No.61/779,028, filed Mar. 13, 2013.

This application claims the benefit of U.S. Patent Application No.61/779,753, filed Mar. 13, 2013.

This application claims the benefit of U.S. Patent Application No.61/780,092, filed Mar. 13, 2013.

This application claims the benefit of U.S. Patent Application No.61/780,290, filed Mar. 13, 2013.

This application claims the benefit of U.S. Patent Application No.61/780,435, filed Mar. 13, 2013.

This application claims the benefit of U.S. Patent Application No.61/780,538, filed Mar. 13, 2013.

This application claims the benefit of U.S. Patent Application No.61/780,637, filed Mar. 13, 2013.

This application claims the benefit of U.S. Patent Application No.61/781,401, filed Mar. 14, 2013.

This application claims the benefit of U.S. Patent Application No.61/781,713, filed Mar. 14, 2013.

This application is a continuation in part application of U.S. patentapplication Ser. No. 12/197,946, filed Aug. 25, 2008.

This application is a continuation in part application of U.S. patentapplication Ser. No. 13/718,851, filed Dec. 18, 2012.

This application is a continuation in part application of U.S. patentapplication Ser. No. 13/932,837, filed Jul. 1, 2013.

This application is a continuation in part application of U.S. patentapplication Ser. No. 11/761,745, filed Jun. 12, 2007.

This application is a continuation in part application of U.S. patentapplication Ser. No. 12/019,568, filed Jan. 24, 2008.

This application is a continuation in part application of U.S. patentapplication Ser. No. 13/925,181, filed Jun. 24, 2013.

This application is a continuation in part application of U.S. patentapplication Ser. No. 13/531,757, filed Jun. 25, 2012.

This application is a continuation in part application of U.S. patentapplication Ser. No. 13/335,279, filed Dec. 22, 2011.

This application is a continuation in part application of U.S. patentapplication Ser. No. 12/539,537, filed Aug. 11, 2009.

This application is a continuation in part application of U.S. patentapplication Ser. No. 12/750,470, filed Mar. 30, 2010.

This application is a continuation in part application of U.S. patentapplication Ser. No. 13/104,932, filed May 10, 2011.

TECHNICAL FIELD

The embodiments described herein relate generally to a method andapparatus for improving the capabilities of security systems in home andbusiness applications. More particularly, the embodiments describedherein relate to a touchscreen device that integrates security systemcontrol and functionality with network content interactivity, managementand presentation.

BACKGROUND

The field of home and small business security is dominated by technologysuppliers who build comprehensive ‘closed’ security systems, where theindividual components (sensors, security panels, keypads) operate solelywithin the confines of a single vendor solution. For example, a wirelessmotion sensor from vendor A cannot be used with a security panel fromvendor B. Each vendor typically has developed sophisticated proprietarywireless technologies to enable the installation and management ofwireless sensors, with little or no ability for the wireless devices tooperate separate from the vendor's homogeneous system. Furthermore,these traditional systems are extremely limited in their ability tointerface either to a local or wide area standards-based network (suchas an IP network); most installed systems support only a low-bandwidth,intermittent connection utilizing phone lines or cellular (RF) backupsystems. Wireless security technology from providers such as GESecurity, Honeywell, and DSC/Tyco are well known in the art, and areexamples of this proprietary approach to security systems for home andbusiness.

Furthermore, with the proliferation of the internet, ethernet and WiFilocal area networks (LANs) and advanced wide area networks (WANs) thatoffer high bandwidth, low latency connections (broadband), as well asmore advanced wireless WAN data networks (e.g. GPRS or CDMA 1×RTT) thereincreasingly exists the networking capability to extend thesetraditional security systems to offer enhanced functionality. Inaddition, the proliferation of broadband access has driven acorresponding increase in home and small business networkingtechnologies and devices. It is desirable to extend traditional securitysystems to encompass enhanced functionality such as the ability tocontrol and manage security systems from the world wide web, cellulartelephones, or advanced function internet-based devices. Other desiredfunctionality includes an open systems approach to interface homesecurity systems to home and small business networks.

Due to the proprietary approach described above, the traditional vendorsare the only ones capable of taking advantage of these new networkfunctions. To date, even though the vast majority of home and businesscustomers have broadband network access in their premises, most securitysystems do not offer the advanced capabilities associated with highspeed, low-latency LANs and WANs. This is primarily because theproprietary vendors have not been able to deliver such technologyefficiently or effectively. Solution providers attempting to addressthis need are becoming known in the art, including three categories ofvendors: traditional proprietary hardware providers such as Honeywelland GE Security; third party hard-wired module providers such asAlarm.com, NextAlarm, and uControl; and new proprietary systemsproviders such as InGrid.

A disadvantage of the prior art technologies of the traditionalproprietary hardware providers arises due to the continued proprietaryapproach of these vendors. As they develop technology in this area itonce again operates only with the hardware from that specific vendor,ignoring the need for a heterogeneous, cross-vendor solution. Yetanother disadvantage of the prior art technologies of the traditionalproprietary hardware providers arises due to the lack of experience andcapability of these companies in creating open internet and web basedsolutions, and consumer friendly interfaces.

A disadvantage of the prior art technologies of the third partyhard-wired module providers arises due to the installation andoperational complexities and functional limitations associated withhardwiring a new component into existing security systems. Moreover, adisadvantage of the prior art technologies of the new proprietarysystems providers arises due to the need to discard all priortechnologies, and implement an entirely new form of security system toaccess the new functionalities associated with broadband and wirelessdata networks. There remains, therefore, a need for systems, devices,and methods that easily interface to and control the existingproprietary security technologies utilizing a variety of wirelesstechnologies.

INCORPORATION BY REFERENCE

Each patent, patent application, and/or publication mentioned in thisspecification is herein incorporated by reference in its entirety to thesame extent as if each individual patent, patent application, and/orpublication was specifically and individually indicated to beincorporated by reference.

BRIEF DESCRIPTION OF THE DRAWINGS

FIG. 1 is a block diagram of the integrated security system, under anembodiment.

FIG. 2 is a block diagram of components of the integrated securitysystem, under an embodiment.

FIG. 3 is a block diagram of the gateway software or applications, underan embodiment.

FIG. 4 is a block diagram of the gateway components, under anembodiment.

FIG. 5 is a block diagram of IP device integration with a premisenetwork, under an embodiment.

FIG. 6 is a block diagram of IP device integration with a premisenetwork, under an alternative embodiment.

FIG. 7 is a block diagram of a touchscreen, under an embodiment.

FIG. 8 is an example screenshot of a networked security touchscreen,under an embodiment.

FIG. 9 is a block diagram of network or premise device integration witha premise network, under an embodiment.

FIG. 10 is a block diagram of network or premise device integration witha premise network, under an alternative embodiment.

FIG. 11 is a flow diagram for a method of forming a security networkincluding integrated security system components, under an embodiment.

FIG. 12 is a flow diagram for a method of forming a security networkincluding integrated security system components and network devices,under an embodiment.

FIG. 13 is a flow diagram for installation of an IP device into aprivate network environment, under an embodiment.

FIG. 14 is a block diagram showing communications among IP devices ofthe private network environment, under an embodiment.

FIG. 15 is a flow diagram of a method of integrating an external controland management application system with an existing security system,under an embodiment.

FIG. 16 is a block diagram of an integrated security system wirelesslyinterfacing to proprietary security systems, under an embodiment.

FIG. 17 is a flow diagram for wirelessly ‘learning’ the gateway into anexisting security system and discovering extant sensors, under anembodiment.

FIG. 18 is a block diagram of a security system in which the legacypanel is replaced with a wireless security panel wirelessly coupled to agateway, under an embodiment.

FIG. 19 is a block diagram of a security system in which the legacypanel is replaced with a wireless security panel wirelessly coupled to agateway, and a touchscreen, under an alternative embodiment.

FIG. 20 is a block diagram of a security system in which the legacypanel is replaced with a wireless security panel connected to a gatewayvia an Ethernet coupling, under another alternative embodiment.

FIG. 21 is a flow diagram for automatic takeover of a security system,under an embodiment.

FIG. 22 is a flow diagram for automatic takeover of a security system,under an alternative embodiment.

FIG. 23 is a general flow diagram for IP video control, under anembodiment.

FIG. 24 is a block diagram showing camera tunneling, under anembodiment.

FIG. 25 is a flow diagram showing the overall architecture of theiControl SMA services, under an embodiment.

FIG. 26 is a flow diagram showing three event messages being reported,under an embodiment.

DETAILED DESCRIPTION

An integrated security system is described that integrates broadband andmobile access and control with conventional security systems and premisedevices to provide a tri-mode security network (broadband, cellular/GSM,POTS access) that enables users to remotely stay connected to theirpremises. The integrated security system, while delivering remotepremise monitoring and control functionality to conventional monitoredpremise protection, complements existing premise protection equipment.The integrated security system integrates into the premise network andcouples wirelessly with the conventional security panel, enablingbroadband access to premise security systems. Automation devices(cameras, lamp modules, thermostats, etc.) can be added, enabling usersto remotely see live video and/or pictures and control home devices viatheir personal web portal or webpage, mobile phone, and/or other remoteclient device. Users can also receive notifications via email or textmessage when happenings occur, or do not occur, in their home.

Although the detailed description herein contains many specifics for thepurposes of illustration, anyone of ordinary skill in the art willappreciate that many variations and alterations to the following detailsare within the scope of the embodiments described herein. Thus, thefollowing illustrative embodiments are set forth without any loss ofgenerality to, and without imposing limitations upon, the claimedinvention.

As described herein, computer networks suitable for use with theembodiments described herein include local area networks (LAN), widearea networks (WAN), Internet, or other connection services and networkvariations such as the world wide web, the public internet, a privateinternet, a private computer network, a public network, a mobilenetwork, a cellular network, a value-added network, and the like.Computing devices coupled or connected to the network may be anymicroprocessor controlled device that permits access to the network,including terminal devices, such as personal computers, workstations,servers, mini computers, main-frame computers, laptop computers, mobilecomputers, palm top computers, hand held computers, mobile phones, TVset-top boxes, or combinations thereof. The computer network may includeone of more LANs, WANs, Internets, and computers. The computers mayserve as servers, clients, or a combination thereof.

The integrated security system can be a component of a single system,multiple systems, and/or geographically separate systems. The integratedsecurity system can also be a subcomponent or subsystem of a singlesystem, multiple systems, and/or geographically separate systems. Theintegrated security system can be coupled to one or more othercomponents (not shown) of a host system or a system coupled to the hostsystem.

One or more components of the integrated security system and/or acorresponding system or application to which the integrated securitysystem is coupled or connected includes and/or runs under and/or inassociation with a processing system. The processing system includes anycollection of processor-based devices or computing devices operatingtogether, or components of processing systems or devices, as is known inthe art. For example, the processing system can include one or more of aportable computer, portable communication device operating in acommunication network, and/or a network server. The portable computercan be any of a number and/or combination of devices selected from amongpersonal computers, personal digital assistants, portable computingdevices, and portable communication devices, but is not so limited. Theprocessing system can include components within a larger computersystem.

The processing system of an embodiment includes at least one processorand at least one memory device or subsystem. The processing system canalso include or be coupled to at least one database. The term“processor” as generally used herein refers to any logic processingunit, such as one or more central processing units (CPUs), digitalsignal processors (DSPs), application-specific integrated circuits(ASIC), etc. The processor and memory can be monolithically integratedonto a single chip, distributed among a number of chips or components,and/or provided by some combination of algorithms. The methods describedherein can be implemented in one or more of software algorithm(s),programs, firmware, hardware, components, circuitry, in any combination.

The components of any system that includes the integrated securitysystem can be located together or in separate locations. Communicationpaths couple the components and include any medium for communicating ortransferring files among the components. The communication paths includewireless connections, wired connections, and hybrid wireless/wiredconnections. The communication paths also include couplings orconnections to networks including local area networks (LANs),metropolitan area networks (MANs), wide area networks (WANs),proprietary networks, interoffice or backend networks, and the Internet.Furthermore, the communication paths include removable fixed mediumslike floppy disks, hard disk drives, and CD-ROM disks, as well as flashRAM, Universal Serial Bus (USB) connections, RS-232 connections,telephone lines, buses, and electronic mail messages.

Aspects of the integrated security system and corresponding systems andmethods described herein may be implemented as functionality programmedinto any of a variety of circuitry, including programmable logic devices(PLDs), such as field programmable gate arrays (FPGAs), programmablearray logic (PAL) devices, electrically programmable logic and memorydevices and standard cell-based devices, as well as application specificintegrated circuits (ASICs). Some other possibilities for implementingaspects of the integrated security system and corresponding systems andmethods include: microcontrollers with memory (such as electronicallyerasable programmable read only memory (EEPROM)), embeddedmicroprocessors, firmware, software, etc. Furthermore, aspects of theintegrated security system and corresponding systems and methods may beembodied in microprocessors having software-based circuit emulation,discrete logic (sequential and combinatorial), custom devices, fuzzy(neural) logic, quantum devices, and hybrids of any of the above devicetypes. Of course the underlying device technologies may be provided in avariety of component types, e.g., metal-oxide semiconductor field-effecttransistor (MOSFET) technologies like complementary metal-oxidesemiconductor (CMOS), bipolar technologies like emitter-coupled logic(ECL), polymer technologies (e.g., silicon-conjugated polymer andmetal-conjugated polymer-metal structures), mixed analog and digital,etc.

It should be noted that any system, method, and/or other componentsdisclosed herein may be described using computer aided design tools andexpressed (or represented), as data and/or instructions embodied invarious computer-readable media, in terms of their behavioral, registertransfer, logic component, transistor, layout geometries, and/or othercharacteristics. Computer-readable media in which such formatted dataand/or instructions may be embodied include, but are not limited to,non-volatile storage media in various forms (e.g., optical, magnetic orsemiconductor storage media) and carrier waves that may be used totransfer such formatted data and/or instructions through wireless,optical, or wired signaling media or any combination thereof. Examplesof transfers of such formatted data and/or instructions by carrier wavesinclude, but are not limited to, transfers (uploads, downloads, e-mail,etc.) over the Internet and/or other computer networks via one or moredata transfer protocols (e.g., HTTP, FTP, SMTP, etc.). When receivedwithin a computer system via one or more computer-readable media, suchdata and/or instruction-based expressions of the above describedcomponents may be processed by a processing entity (e.g., one or moreprocessors) within the computer system in conjunction with execution ofone or more other computer programs.

Unless the context clearly requires otherwise, throughout thedescription and the claims, the words “comprise,” “comprising,” and thelike are to be construed in an inclusive sense as opposed to anexclusive or exhaustive sense; that is to say, in a sense of “including,but not limited to.” Words using the singular or plural number alsoinclude the plural or singular number respectively. Additionally, thewords “herein,” “hereunder,” “above,” “below,” and words of similarimport, when used in this application, refer to this application as awhole and not to any particular portions of this application. When theword “or” is used in reference to a list of two or more items, that wordcovers all of the following interpretations of the word: any of theitems in the list, all of the items in the list and any combination ofthe items in the list.

The above description of embodiments of the integrated security systemand corresponding systems and methods is not intended to be exhaustiveor to limit the systems and methods to the precise forms disclosed.While specific embodiments of, and examples for, the integrated securitysystem and corresponding systems and methods are described herein forillustrative purposes, various equivalent modifications are possiblewithin the scope of the systems and methods, as those skilled in therelevant art will recognize. The teachings of the integrated securitysystem and corresponding systems and methods provided herein can beapplied to other systems and methods, not only for the systems andmethods described above.

The elements and acts of the various embodiments described above can becombined to provide further embodiments. These and other changes can bemade to the integrated security system and corresponding systems andmethods in light of the above detailed description.

In accordance with the embodiments described herein, a wireless system(e.g., radio frequency (RF)) is provided that enables a securityprovider or consumer to extend the capabilities of an existingRF-capable security system or a non-RF-capable security system that hasbeen upgraded to support RF capabilities. The system includes anRF-capable Gateway device (physically located within RF range of theRF-capable security system) and associated software operating on theGateway device. The system also includes a web server, applicationserver, and remote database providing a persistent store for informationrelated to the system.

The security systems of an embodiment, referred to herein as theiControl security system or integrated security system, extend the valueof traditional home security by adding broadband access and theadvantages of remote home monitoring and home control through theformation of a security network including components of the integratedsecurity system integrated with a conventional premise security systemand a premise local area network (LAN). With the integrated securitysystem, conventional home security sensors, cameras, touchscreenkeypads, lighting controls, and/or Internet Protocol (IP) devices in thehome (or business) become connected devices that are accessible anywherein the world from a web browser, mobile phone or through content-enabledtouchscreens. The integrated security system experience allows securityoperators to both extend the value proposition of their monitoredsecurity systems and reach new consumers that include broadband usersinterested in staying connected to their family, home and property whenthey are away from home.

The integrated security system of an embodiment includes securityservers (also referred to herein as iConnect servers or security networkservers) and an iHub gateway (also referred to herein as the gateway,the iHub, or the iHub client) that couples or integrates into a homenetwork (e.g., LAN) and communicates directly with the home securitypanel, in both wired and wireless installations. The security system ofan embodiment automatically discovers the security system components(e.g., sensors, etc.) belonging to the security system and connected toa control panel of the security system and provides consumers with fulltwo-way access via web and mobile portals. The gateway supports variouswireless protocols and can interconnect with a wide range of controlpanels offered by security system providers. Service providers and userscan then extend the system's capabilities with the additional IPcameras, lighting modules or security devices such as interactivetouchscreen keypads. The integrated security system adds an enhancedvalue to these security systems by enabling consumers to stay connectedthrough email and SMS alerts, photo push, event-based video capture andrule-based monitoring and notifications. This solution extends the reachof home security to households with broadband access.

The integrated security system builds upon the foundation afforded bytraditional security systems by layering broadband and mobile access, IPcameras, interactive touchscreens, and an open approach to homeautomation on top of traditional security system configurations. Theintegrated security system is easily installed and managed by thesecurity operator, and simplifies the traditional security installationprocess, as described below.

The integrated security system provides an open systems solution to thehome security market. As such, the foundation of the integrated securitysystem customer premises equipment (CPE) approach has been to abstractdevices, and allows applications to manipulate and manage multipledevices from any vendor. The integrated security system DeviceConnecttechnology that enables this capability supports protocols, devices, andpanels from GE Security and Honeywell, as well as consumer devices usingZ-Wave, IP cameras (e.g., Ethernet, wifi, and Homeplug), and IPtouchscreens. The DeviceConnect is a device abstraction layer thatenables any device or protocol layer to interoperate with integratedsecurity system components. This architecture enables the addition ofnew devices supporting any of these interfaces, as well as add entirelynew protocols.

The benefit of DeviceConnect is that it provides supplier flexibility.The same consistent touchscreen, web, and mobile user experience operateunchanged on whatever security equipment selected by a security systemprovider, with the system provider's choice of IP cameras, backend datacenter and central station software.

The integrated security system provides a complete system thatintegrates or layers on top of a conventional host security systemavailable from a security system provider. The security system providertherefore can select different components or configurations to offer(e.g., CDMA, GPRS, no cellular, etc.) as well as have iControl modifythe integrated security system configuration for the system provider'sspecific needs (e.g., change the functionality of the web or mobileportal, add a GE or Honeywell-compatible TouchScreen, etc.).

The integrated security system integrates with the security systemprovider infrastructure for central station reporting directly viaBroadband and GPRS alarm transmissions. Traditional dial-up reporting issupported via the standard panel connectivity. Additionally, theintegrated security system provides interfaces for advancedfunctionality to the CMS, including enhanced alarm events, systeminstallation optimizations, system test verification, videoverification, 2-way voice over IP and GSM.

The integrated security system is an IP centric system that includesbroadband connectivity so that the gateway augments the existingsecurity system with broadband and GPRS connectivity. If broadband isdown or unavailable GPRS may be used, for example. The integratedsecurity system supports GPRS connectivity using an optional wirelesspackage that includes a GPRS modem in the gateway. The integratedsecurity system treats the GPRS connection as a higher cost thoughflexible option for data transfers. In an embodiment the GPRS connectionis only used to route alarm events (e.g., for cost), however the gatewaycan be configured (e.g., through the iConnect server interface) to actas a primary channel and pass any or all events over GPRS. Consequently,the integrated security system does not interfere with the current plainold telephone service (POTS) security panel interface. Alarm events canstill be routed through POTS; however the gateway also allows suchevents to be routed through a broadband or GPRS connection as well. Theintegrated security system provides a web application interface to theCSR tool suite as well as XML web services interfaces for programmaticintegration between the security system provider's existing call centerproducts. The integrated security system includes, for example, APIsthat allow the security system provider to integrate components of theintegrated security system into a custom call center interface. The APIsinclude XML web service APIs for integration of existing security systemprovider call center applications with the integrated security systemservice. All functionality available in the CSR Web application isprovided with these API sets. The Java and XML-based APIs of theintegrated security system support provisioning, billing, systemadministration, CSR, central station, portal user interfaces, andcontent management functions, to name a few. The integrated securitysystem can provide a customized interface to the security systemprovider's billing system, or alternatively can provide security systemdevelopers with APIs and support in the integration effort.

The integrated security system provides or includes business componentinterfaces for provisioning, administration, and customer care to name afew. Standard templates and examples are provided with a definedcustomer professional services engagement to help integrate OSS/BSSsystems of a Service Provider with the integrated security system.

The integrated security system components support and allow for theintegration of customer account creation and deletion with a securitysystem. The iConnect APIs provides access to the provisioning andaccount management system in iConnect and provide full support foraccount creation, provisioning, and deletion. Depending on therequirements of the security system provider, the iConnect APIs can beused to completely customize any aspect of the integrated securitysystem backend operational system.

The integrated security system includes a gateway that supports thefollowing standards-based interfaces, to name a few: Ethernet IPcommunications via Ethernet ports on the gateway, and standardXML/TCP/IP protocols and ports are employed over secured SSL sessions;USB 2.0 via ports on the gateway; 802.11b/g/n IP communications;GSM/GPRS RF WAN communications; CDMA 1×RTT RF WAN communications(optional, can also support EVDO and 3G technologies).

The gateway supports the following proprietary interfaces, to name afew: interfaces including Dialog RF network (319.5 MHz) and RS485Superbus 2000 wired interface; RF mesh network (908 MHz); and interfacesincluding RF network (345 MHz) and RS485/RS232bus wired interfaces.

Regarding security for the IP communications (e.g., authentication,authorization, encryption, anti-spoofing, etc), the integrated securitysystem uses SSL to encrypt all IP traffic, using server andclient-certificates for authentication, as well as authentication in thedata sent over the SSL-encrypted channel. For encryption, integratedsecurity system issues public/private key pairs at the time/place ofmanufacture, and certificates are not stored in any online storage in anembodiment.

The integrated security system does not need any special rules at thecustomer premise and/or at the security system provider central stationbecause the integrated security system makes outgoing connections usingTCP over the standard HTTP and HTTPS ports. Provided outbound TCPconnections are allowed then no special requirements on the firewallsare necessary.

FIG. 1 is a block diagram of the integrated security system 100, underan embodiment. The integrated security system 100 of an embodimentincludes the gateway 102 and the security servers 104 coupled to theconventional home security system 110. At a customer's home or business,the gateway 102 connects and manages the diverse variety of homesecurity and self-monitoring devices. The gateway 102 communicates withthe iConnect Servers 104 located in the service provider's data center106 (or hosted in integrated security system data center), with thecommunication taking place via a communication network 108 or othernetwork (e.g., cellular network, internet, etc.). These servers 104manage the system integrations necessary to deliver the integratedsystem service described herein. The combination of the gateway 102 andthe iConnect servers 104 enable a wide variety of remote client devices120 (e.g., PCs, mobile phones and PDAs) allowing users to remotely stayin touch with their home, business and family. In addition, thetechnology allows home security and self-monitoring information, as wellas relevant third party content such as traffic and weather, to bepresented in intuitive ways within the home, such as on advancedtouchscreen keypads.

The integrated security system service (also referred to as iControlservice) can be managed by a service provider via browser-basedMaintenance and Service Management applications that are provided withthe iConnect Servers. Or, if desired, the service can be more tightlyintegrated with existing OSS/BSS and service delivery systems via theiConnect web services-based XML APIs.

The integrated security system service can also coordinate the sendingof alarms to the home security Central Monitoring Station (CMS) 199.Alarms are passed to the CMS 199 using standard protocols such asContact ID or SIA and can be generated from the home security panellocation as well as by iConnect server 104 conditions (such as lack ofcommunications with the integrated security system). In addition, thelink between the security servers 104 and CMS 199 provides tighterintegration between home security and self-monitoring devices and thegateway 102. Such integration enables advanced security capabilitiessuch as the ability for CMS personnel to view photos taken at the time aburglary alarm was triggered. For maximum security, the gateway 102 andiConnect servers 104 support the use of a mobile network (both GPRS andCDMA options are available) as a backup to the primary broadbandconnection.

The integrated security system service is delivered by hosted serversrunning software components that communicate with a variety of clienttypes while interacting with other systems. FIG. 2 is a block diagram ofcomponents of the integrated security system 100, under an embodiment.Following is a more detailed description of the components.

The iConnect servers 104 support a diverse collection of clients 120ranging from mobile devices, to PCs, to in-home security devices, to aservice provider's internal systems. Most clients 120 are used byend-users, but there are also a number of clients 120 that are used tooperate the service.

Clients 120 used by end-users of the integrated security system 100include, but are not limited to, the following:

-   -   Clients based on gateway client applications 202 (e.g., a        processor-based device running the gateway technology that        manages home security and automation devices).    -   A web browser 204 accessing a Web Portal application, performing        end-user configuration and customization of the integrated        security system service as well as monitoring of in-home device        status, viewing photos and video, etc. Device and user        management can also be performed by this portal application.    -   A mobile device 206 (e.g., PDA, mobile phone, etc.) accessing        the integrated security system Mobile Portal. This type of        client 206 is used by end-users to view system status and        perform operations on devices (e.g., turning on a lamp, arming a        security panel, etc.) rather than for system configuration tasks        such as adding a new device or user.    -   PC or browser-based “widget” containers 208 that present        integrated security system service content, as well as other        third-party content, in simple, targeted ways (e.g. a widget        that resides on a PC desktop and shows live video from a single        in-home camera). “Widget” as used herein means applications or        programs in the system.    -   Touchscreen home security keypads 208 and advanced in-home        devices that present a variety of content widgets via an        intuitive touchscreen user interface.    -   Notification recipients 210 (e.g., cell phones that receive        SMS-based notifications when certain events occur (or don't        occur), email clients that receive an email message with similar        information, etc.).    -   Custom-built clients (not shown) that access the iConnect web        services XML API to interact with users' home security and        self-monitoring information in new and unique ways. Such clients        could include new types of mobile devices, or complex        applications where integrated security system content is        integrated into a broader set of application features.

In addition to the end-user clients, the iConnect servers 104 support PCbrowser-based Service Management clients that manage the ongoingoperation of the overall service. These clients run applications thathandle tasks such as provisioning, service monitoring, customer supportand reporting.

There are numerous types of server components of the iConnect servers104 of an embodiment including, but not limited to, the following:Business Components which manage information about all of the homesecurity and self-monitoring devices; End-User Application Componentswhich display that information for users and access the BusinessComponents via published XML APIs; and Service Management ApplicationComponents which enable operators to administer the service (thesecomponents also access the Business Components via the XML APIs, andalso via published SNMP MIBs).

The server components provide access to, and management of, the objectsassociated with an integrated security system installation. Thetop-level object is the “network.” It is a location where a gateway 102is located, and is also commonly referred to as a site or premises; thepremises can include any type of structure (e.g., home, office,warehouse, etc.) at which a gateway 102 is located. Users can onlyaccess the networks to which they have been granted permission. Within anetwork, every object monitored by the gateway 102 is called a device.Devices include the sensors, cameras, home security panels andautomation devices, as well as the controller or processor-based devicerunning the gateway applications.

Various types of interactions are possible between the objects in asystem. Automations define actions that occur as a result of a change instate of a device. For example, take a picture with the front entrycamera when the front door sensor changes to “open”. Notifications aremessages sent to users to indicate that something has occurred, such asthe front door going to “open” state, or has not occurred (referred toas an iWatch notification). Schedules define changes in device statesthat are to take place at predefined days and times. For example, setthe security panel to “Armed” mode every weeknight at 11:00 pm.

The iConnect Business Components are responsible for orchestrating allof the low-level service management activities for the integratedsecurity system service. They define all of the users and devicesassociated with a network (site), analyze how the devices interact, andtrigger associated actions (such as sending notifications to users). Allchanges in device states are monitored and logged. The BusinessComponents also manage all interactions with external systems asrequired, including sending alarms and other related self-monitoringdata to the home security Central Monitoring System (CMS) 199. TheBusiness Components are implemented as portable Java J2EE Servlets, butare not so limited.

The following iConnect Business Components manage the main elements ofthe integrated security system service, but the embodiment is not solimited:

-   -   A Registry Manager 220 defines and manages users and networks.        This component is responsible for the creation, modification and        termination of users and networks. It is also where a user's        access to networks is defined.    -   A Network Manager 222 defines and manages security and        self-monitoring devices that are deployed on a network (site).        This component handles the creation, modification, deletion and        configuration of the devices, as well as the creation of        automations, schedules and notification rules associated with        those devices.    -   A Data Manager 224 manages access to current and logged state        data for an existing network and its devices. This component        specifically does not provide any access to network management        capabilities, such as adding new devices to a network, which are        handled exclusively by the Network Manager 222.    -   To achieve optimal performance for all types of queries, data        for current device states is stored separately from historical        state data (a.k.a. “logs”) in the database. A Log Data Manager        226 performs ongoing transfers of current device state data to        the historical data log tables.

Additional iConnect Business Components handle direct communicationswith certain clients and other systems, for example:

-   -   An iHub Manager 228 directly manages all communications with        gateway clients, including receiving information about device        state changes, changing the configuration of devices, and        pushing new versions of the gateway client to the hardware it is        running on.    -   A Notification Manager 230 is responsible for sending all        notifications to clients via SMS (mobile phone messages), email        (via a relay server like an SMTP email server), etc.    -   An Alarm and CMS Manager 232 sends critical server-generated        alarm events to the home security Central Monitoring Station        (CMS) and manages all other communications of integrated        security system service data to and from the CMS.    -   The Element Management System (EMS) 234 is an iControl Business        Component that manages all activities associated with service        installation, scaling and monitoring, and filters and packages        service operations data for use by service management        applications. The SNMP MIBs published by the EMS can also be        incorporated into any third party monitoring system if desired.

The iConnect Business Components store information about the objectsthat they manage in the iControl Service Database 240 and in theiControl Content Store 242. The iControl Content Store is used to storemedia objects like video, photos and widget content, while the ServiceDatabase stores information about users, networks, and devices. Databaseinteraction is performed via a JDBC interface. For security purposes,the Business Components manage all data storage and retrieval.

The iControl Business Components provide web services-based APIs thatapplication components use to access the Business Components'capabilities. Functions of application components include presentingintegrated security system service data to end-users, performingadministrative duties, and integrating with external systems andback-office applications.

The primary published APIs for the iConnect Business Components include,but are not limited to, the following:

-   -   A Registry Manager API 252 provides access to the Registry        Manager Business Component's functionality, allowing management        of networks and users.    -   A Network Manager API 254 provides access to the Network Manager        Business Component's functionality, allowing management of        devices on a network.    -   A Data Manager API 256 provides access to the Data Manager        Business Component's functionality, such as setting and        retrieving (current and historical) data about device states.    -   A Provisioning API 258 provides a simple way to create new        networks and configure initial default properties.

Each API of an embodiment includes two modes of access: Java API or XMLAPI. The XML APIs are published as web services so that they can beeasily accessed by applications or servers over a network. The Java APIsare a programmer-friendly wrapper for the XML APIs. Applicationcomponents and integrations written in Java should generally use theJava APIs rather than the XML APIs directly.

The iConnect Business Components also have an XML-based interface 260for quickly adding support for new devices to the integrated securitysystem. This interface 260, referred to as DeviceConnect 260, is aflexible, standards-based mechanism for defining the properties of newdevices and how they can be managed. Although the format is flexibleenough to allow the addition of any type of future device, pre-definedXML profiles are currently available for adding common types of devicessuch as sensors (SensorConnect), home security panels (PanelConnect) andIP cameras (CameraConnect).

The iConnect End-User Application Components deliver the user interfacesthat run on the different types of clients supported by the integratedsecurity system service. The components are written in portable JavaJ2EE technology (e.g., as Java Servlets, as JavaServer Pages (JSPs),etc.) and they all interact with the iControl Business Components viathe published APIs.

The following End-User Application Components generate CSS-basedHTML/JavaScript that is displayed on the target client. Theseapplications can be dynamically branded with partner-specific logos andURL links (such as Customer Support, etc.). The End-User ApplicationComponents of an embodiment include, but are not limited to, thefollowing:

-   -   An iControl Activation Application 270 that delivers the first        application that a user sees when they set up the integrated        security system service. This wizard-based web browser        application securely associates a new user with a purchased        gateway and the other devices included with it as a kit (if        any). It primarily uses functionality published by the        Provisioning API.    -   An iControl Web Portal Application 272 runs on PC browsers and        delivers the web-based interface to the integrated security        system service. This application allows users to manage their        networks (e.g. add devices and create automations) as well as to        view/change device states, and manage pictures and videos.        Because of the wide scope of capabilities of this application,        it uses three different Business Component APIs that include the        Registry Manager API, Network Manager API, and Data Manager API,        but the embodiment is not so limited.    -   An iControl Mobile Portal 274 is a small-footprint web-based        interface that runs on mobile phones and PDAs. This interface is        optimized for remote viewing of device states and        pictures/videos rather than network management. As such, its        interaction with the Business Components is primarily via the        Data Manager API.    -   Custom portals and targeted client applications can be provided        that leverage the same Business Component APIs used by the above        applications.    -   A Content Manager Application Component 276 delivers content to        a variety of clients. It sends multimedia-rich user interface        components to widget container clients (both PC and        browser-based), as well as to advanced touchscreen keypad        clients. In addition to providing content directly to end-user        devices, the Content Manager 276 provides widget-based user        interface components to satisfy requests from other Application        Components such as the iControl Web 272 and Mobile 274 portals.

A number of Application Components are responsible for overallmanagement of the service. These pre-defined applications, referred toas Service Management Application Components, are configured to offeroff-the-shelf solutions for production management of the integratedsecurity system service including provisioning, overall servicemonitoring, customer support, and reporting, for example. The ServiceManagement Application Components of an embodiment include, but are notlimited to, the following:

-   -   A Service Management Application 280 allows service        administrators to perform activities associated with service        installation, scaling and monitoring/alerting. This application        interacts heavily with the Element Management System (EMS)        Business Component to execute its functionality, and also        retrieves its monitoring data from that component via protocols        such as SNMP MIBs.    -   A Kitting Application 282 is used by employees performing        service provisioning tasks. This application allows home        security and self-monitoring devices to be associated with        gateways during the warehouse kitting process.    -   A CSR Application and Report Generator 284 is used by personnel        supporting the integrated security system service, such as CSRs        resolving end-user issues and employees inquiring about overall        service usage. The push of new gateway firmware to deployed        gateways is also managed by this application.

The iConnect servers 104 also support custom-built integrations with aservice provider's existing OSS/BSS, CSR and service delivery systems290. Such systems can access the iConnect web services XML API totransfer data to and from the iConnect servers 104. These types ofintegrations can compliment or replace the PC browser-based ServiceManagement applications, depending on service provider needs.

As described above, the integrated security system of an embodimentincludes a gateway, or iHub. The gateway of an embodiment includes adevice that is deployed in the home or business and couples or connectsthe various third-party cameras, home security panels, sensors anddevices to the iConnect server over a WAN connection as described indetail herein. The gateway couples to the home network and communicatesdirectly with the home security panel in both wired and wireless sensorinstallations. The gateway is configured to be low-cost, reliable andthin so that it complements the integrated security system network-basedarchitecture.

The gateway supports various wireless protocols and can interconnectwith a wide range of home security control panels. Service providers andusers can then extend the system's capabilities by adding IP cameras,lighting modules and additional security devices. The gateway isconfigurable to be integrated into many consumer appliances, includingset-top boxes, routers and security panels. The small and efficientfootprint of the gateway enables this portability and versatility,thereby simplifying and reducing the overall cost of the deployment.

FIG. 3 is a block diagram of the gateway 102 including gateway softwareor applications, under an embodiment. The gateway software architectureis relatively thin and efficient, thereby simplifying its integrationinto other consumer appliances such as set-top boxes, routers, touchscreens and security panels. The software architecture also provides ahigh degree of security against unauthorized access. This sectiondescribes the various key components of the gateway softwarearchitecture.

The gateway application layer 302 is the main program that orchestratesthe operations performed by the gateway. The Security Engine 304provides robust protection against intentional and unintentionalintrusion into the integrated security system network from the outsideworld (both from inside the premises as well as from the WAN). TheSecurity Engine 304 of an embodiment comprises one or more sub-modulesor components that perform functions including, but not limited to, thefollowing:

-   -   Encryption including 128-bit SSL encryption for gateway and        iConnect server communication to protect user data privacy and        provide secure communication.    -   Bi-directional authentication between the gateway and iConnect        server in order to prevent unauthorized spoofing and attacks.        Data sent from the iConnect server to the gateway application        (or vice versa) is digitally signed as an additional layer of        security. Digital signing provides both authentication and        validation that the data has not been altered in transit.    -   Camera SSL encapsulation because picture and video traffic        offered by off-the-shelf networked IP cameras is not secure when        traveling over the Internet. The gateway provides for 128-bit        SSL encapsulation of the user picture and video data sent over        the internet for complete user security and privacy.    -   802.11b/g/n with WPA-2 security to ensure that wireless camera        communications always takes place using the strongest available        protection.    -   A gateway-enabled device is assigned a unique activation key for        activation with an iConnect server. This ensures that only valid        gateway-enabled devices can be activated for use with the        specific instance of iConnect server in use. Attempts to        activate gateway-enabled devices by brute force are detected by        the Security Engine. Partners deploying gateway-enabled devices        have the knowledge that only a gateway with the correct serial        number and activation key can be activated for use with an        iConnect server. Stolen devices, devices attempting to        masquerade as gateway-enabled devices, and malicious outsiders        (or insiders as knowledgeable but nefarious customers) cannot        effect other customers' gateway-enabled devices.

As standards evolve, and new encryption and authentication methods areproven to be useful, and older mechanisms proven to be breakable, thesecurity manager can be upgraded “over the air” to provide new andbetter security for communications between the iConnect server and thegateway application, and locally at the premises to remove any risk ofeavesdropping on camera communications.

A Remote Firmware Download module 306 allows for seamless and secureupdates to the gateway firmware through the iControl MaintenanceApplication on the server 104, providing a transparent, hassle-freemechanism for the service provider to deploy new features and bug fixesto the installed user base. The firmware download mechanism is tolerantof connection loss, power interruption and user interventions (bothintentional and unintentional). Such robustness reduces down time andcustomer support issues. Gateway firmware can be remotely downloadeither for one gateway at a time, a group of gateways, or in batches.

The Automations engine 308 manages the user-defined rules of interactionbetween the different devices (e.g. when door opens turn on the light).Though the automation rules are programmed and reside at theportal/server level, they are cached at the gateway level in order toprovide short latency between device triggers and actions.

DeviceConnect 310 includes definitions of all supported devices (e.g.,cameras, security panels, sensors, etc.) using a standardized plug-inarchitecture. The DeviceConnect module 310 offers an interface that canbe used to quickly add support for any new device as well as enablinginteroperability between devices that use differenttechnologies/protocols. For common device types, pre-defined sub-moduleshave been defined, making supporting new devices of these types eveneasier. SensorConnect 312 is provided for adding new sensors,CameraConnect 316 for adding IP cameras, and PanelConnect 314 for addinghome security panels.

The Schedules engine 318 is responsible for executing the user definedschedules (e.g., take a picture every five minutes; every day at 8 amset temperature to 65 degrees Fahrenheit, etc.). Though the schedulesare programmed and reside at the iConnect server level they are sent tothe scheduler within the gateway application. The Schedules Engine 318then interfaces with SensorConnect 312 to ensure that scheduled eventsoccur at precisely the desired time.

The Device Management module 320 is in charge of all discovery,installation and configuration of both wired and wireless IP devices(e.g., cameras, etc.) coupled or connected to the system. Networked IPdevices, such as those used in the integrated security system, requireuser configuration of many IP and security parameters—to simplify theuser experience and reduce the customer support burden, the devicemanagement module of an embodiment handles the details of thisconfiguration. The device management module also manages the videorouting module described below.

The video routing engine 322 is responsible for delivering seamlessvideo streams to the user with zero-configuration. Through a multi-step,staged approach the video routing engine uses a combination of UPnPport-forwarding, relay server routing and STUN/TURN peer-to-peerrouting.

FIG. 4 is a block diagram of components of the gateway 102, under anembodiment. Depending on the specific set of functionality desired bythe service provider deploying the integrated security system service,the gateway 102 can use any of a number of processors 402, due to thesmall footprint of the gateway application firmware. In an embodiment,the gateway could include the Broadcom BCM5354 as the processor forexample. In addition, the gateway 102 includes memory (e.g., FLASH 404,RAM 406, etc.) and any number of input/output (I/O) ports 408.

Referring to the WAN portion 410 of the gateway 102, the gateway 102 ofan embodiment can communicate with the iConnect server using a number ofcommunication types and/or protocols, for example Broadband 412, GPRS414 and/or Public Switched Telephone Network (PTSN) 416 to name a few.In general, broadband communication 412 is the primary means ofconnection between the gateway 102 and the iConnect server 104 and theGPRS/CDMA 414 and/or PSTN 416 interfaces acts as back-up for faulttolerance in case the user's broadband connection fails for whateverreason, but the embodiment is not so limited.

Referring to the LAN portion 420 of the gateway 102, various protocolsand physical transceivers can be used to communicate to off-the-shelfsensors and cameras. The gateway 102 is protocol-agnostic andtechnology-agnostic and as such can easily support almost any devicenetworking protocol. The gateway 102 can, for example, support GE andHoneywell security RF protocols 422, Z-Wave 424, serial (RS232 andRS485) 426 for direct connection to security panels as well as WiFi 428(802.11b/g) for communication to WiFi cameras.

The integrated security system includes couplings or connections among avariety of IP devices or components, and the device management module isin charge of the discovery, installation and configuration of the IPdevices coupled or connected to the system, as described above. Theintegrated security system of an embodiment uses a “sandbox” network todiscover and manage all IP devices coupled or connected as components ofthe system. The IP devices of an embodiment include wired devices,wireless devices, cameras, interactive touchscreens, and security panelsto name a few. These devices can be wired via ethernet cable or Wifidevices, all of which are secured within the sandbox network, asdescribed below. The “sandbox” network is described in detail below.

FIG. 5 is a block diagram 500 of network or premise device integrationwith a premise network 250, under an embodiment. In an embodiment,network devices 255-257 are coupled to the gateway 102 using a securenetwork coupling or connection such as SSL over an encrypted 802.11 link(utilizing for example WPA-2 security for the wireless encryption). Thenetwork coupling or connection between the gateway 102 and the networkdevices 255-257 is a private coupling or connection in that it issegregated from any other network couplings or connections. The gateway102 is coupled to the premise router/firewall 252 via a coupling with apremise LAN 250. The premise router/firewall 252 is coupled to abroadband modem 251, and the broadband modem 251 is coupled to a WAN 200or other network outside the premise. The gateway 102 thus enables orforms a separate wireless network, or sub-network, that includes somenumber of devices and is coupled or connected to the LAN 250 of the hostpremises. The gateway sub-network can include, but is not limited to,any number of other devices like WiFi IP cameras, security panels (e.g.,IP-enabled), and security touchscreens, to name a few. The gateway 102manages or controls the sub-network separately from the LAN 250 andtransfers data and information between components of the sub-network andthe LAN 250/WAN 200, but is not so limited. Additionally, other networkdevices 254 can be coupled to the LAN 250 without being coupled to thegateway 102.

FIG. 6 is a block diagram 600 of network or premise device integrationwith a premise network 250, under an alternative embodiment. The networkor premise devices 255-257 are coupled to the gateway 102. The networkcoupling or connection between the gateway 102 and the network devices255-257 is a private coupling or connection in that it is segregatedfrom any other network couplings or connections. The gateway 102 iscoupled or connected between the premise router/firewall 252 and thebroadband modem 251. The broadband modem 251 is coupled to a WAN 200 orother network outside the premise, while the premise router/firewall 252is coupled to a premise LAN 250. As a result of its location between thebroadband modem 251 and the premise router/firewall 252, the gateway 102can be configured or function as the premise router routing specifieddata between the outside network (e.g., WAN 200) and the premiserouter/firewall 252 of the LAN 250. As described above, the gateway 102in this configuration enables or forms a separate wireless network, orsub-network, that includes the network or premise devices 255-257 and iscoupled or connected between the LAN 250 of the host premises and theWAN 200. The gateway sub-network can include, but is not limited to, anynumber of network or premise devices 255-257 like WiFi IP cameras,security panels (e.g., IP-enabled), and security touchscreens, to name afew. The gateway 102 manages or controls the sub-network separately fromthe LAN 250 and transfers data and information between components of thesub-network and the LAN 250/WAN 200, but is not so limited.Additionally, other network devices 254 can be coupled to the LAN 250without being coupled to the gateway 102.

The examples described above with reference to FIGS. 5 and 6 arepresented only as examples of IP device integration. The integratedsecurity system is not limited to the type, number and/or combination ofIP devices shown and described in these examples, and any type, numberand/or combination of IP devices is contemplated within the scope ofthis disclosure as capable of being integrated with the premise network.

The integrated security system of an embodiment includes a touchscreen(also referred to as the iControl touchscreen or integrated securitysystem touchscreen), as described above, which provides core securitykeypad functionality, content management and presentation, and embeddedsystems design. The networked security touchscreen system of anembodiment enables a consumer or security provider to easily andautomatically install, configure and manage the security system andtouchscreen located at a customer premise. Using this system thecustomer may access and control the local security system, local IPdevices such as cameras, local sensors and control devices (such aslighting controls or pipe freeze sensors), as well as the local securitysystem panel and associated security sensors (such as door/window,motion, and smoke detectors). The customer premise may be a home,business, and/or other location equipped with a wired or wirelessbroadband IP connection.

The system of an embodiment includes a touchscreen with a configurablesoftware user interface and/or a gateway device (e.g., iHub) thatcouples or connects to a premise security panel through a wired orwireless connection, and a remote server that provides access to contentand information from the premises devices to a user when they are remotefrom the home. The touchscreen supports broadband and/or WAN wirelessconnectivity. In this embodiment, the touchscreen incorporates an IPbroadband connection (e.g., Wifi radio, Ethernet port, etc.), and/or acellular radio (e.g., GPRS/GSM, CDMA, WiMax, etc.). The touchscreendescribed herein can be used as one or more of a security systeminterface panel and a network user interface (UI) that provides aninterface to interact with a network (e.g., LAN, WAN, internet, etc.).

The touchscreen of an embodiment provides an integrated touchscreen andsecurity panel as an all-in-one device. Once integrated using thetouchscreen, the touchscreen and a security panel of a premise securitysystem become physically co-located in one device, and the functionalityof both may even be co-resident on the same CPU and memory (though thisis not required).

The touchscreen of an embodiment also provides an integrated IP videoand touchscreen UI. As such, the touchscreen supports one or morestandard video CODECs/players (e.g., H.264, Flash Video, MOV, MPEG4,M-JPEG, etc.). The touchscreen UI then provides a mechanism (such as acamera or video widget) to play video. In an embodiment the video isstreamed live from an IP video camera. In other embodiments the videocomprises video clips or photos sent from an IP camera or from a remotelocation.

The touchscreen of an embodiment provides a configurable user interfacesystem that includes a configuration supporting use as a securitytouchscreen. In this embodiment, the touchscreen utilizes a modular userinterface that allows components to be modified easily by a serviceprovider, an installer, or even the end user. Examples of such a modularapproach include using Flash widgets, HTML-based widgets, or otherdownloadable code modules such that the user interface of thetouchscreen can be updated and modified while the application isrunning. In an embodiment the touchscreen user interface modules can bedownloaded over the internet. For example, a new security configurationwidget can be downloaded from a standard web server, and the touchscreenthen loads such configuration app into memory, and inserts it in placeof the old security configuration widget. The touchscreen of anembodiment is configured to provide a self-install user interface.

Embodiments of the networked security touchscreen system describedherein include a touchscreen device with a user interface that includesa security toolbar providing one or more functions including arm,disarm, panic, medic, and alert. The touchscreen therefore includes atleast one screen having a separate region of the screen dedicated to asecurity toolbar. The security toolbar of an embodiment is present inthe dedicated region at all times that the screen is active.

The touchscreen of an embodiment includes a home screen having aseparate region of the screen allocated to managing home-basedfunctions. The home-based functions of an embodiment include managing,viewing, and/or controlling IP video cameras. In this embodiment,regions of the home screen are allocated in the form of widget icons;these widget icons (e.g. for cameras, thermostats, lighting, etc)provide functionality for managing home systems. So, for example, adisplayed camera icon, when selected, launches a Camera Widget, and theCamera widget in turn provides access to video from one or more cameras,as well as providing the user with relevant camera controls (take apicture, focus the camera, etc.)

The touchscreen of an embodiment includes a home screen having aseparate region of the screen allocated to managing, viewing, and/orcontrolling internet-based content or applications. For example, theWidget Manager UI presents a region of the home screen (up to andincluding the entire home screen) where internet widgets icons such asweather, sports, etc. may be accessed). Each of these icons may beselected to launch their respective content services.

The touchscreen of an embodiment is integrated into a premise networkusing the gateway, as described above. The gateway as described hereinfunctions to enable a separate wireless network, or sub-network, that iscoupled, connected, or integrated with another network (e.g., WAN, LANof the host premises, etc.). The sub-network enabled by the gatewayoptimizes the installation process for IP devices, like the touchscreen,that couple or connect to the sub-network by segregating these IPdevices from other such devices on the network. This segregation of theIP devices of the sub-network further enables separate security andprivacy policies to be implemented for these IP devices so that, wherethe IP devices are dedicated to specific functions (e.g., security), thesecurity and privacy policies can be tailored specifically for thespecific functions. Furthermore, the gateway and the sub-network itforms enables the segregation of data traffic, resulting in faster andmore efficient data flow between components of the host network,components of the sub-network, and between components of the sub-networkand components of the network.

The touchscreen of an embodiment includes a core functional embeddedsystem that includes an embedded operating system, required hardwaredrivers, and an open system interface to name a few. The core functionalembedded system can be provided by or as a component of a conventionalsecurity system (e.g., security system available from GE Security).These core functional units are used with components of the integratedsecurity system as described herein. Note that portions of thetouchscreen description below may include reference to a host premisesecurity system (e.g., GE security system), but these references areincluded only as an example and do not limit the touchscreen tointegration with any particular security system.

As an example, regarding the core functional embedded system, a reducedmemory footprint version of embedded Linux forms the core operatingsystem in an embodiment, and provides basic TCP/IP stack and memorymanagement functions, along with a basic set of low-level graphicsprimitives. A set of device drivers is also provided or included thatoffer low-level hardware and network interfaces. In addition to thestandard drivers, an interface to the RS 485 bus is included thatcouples or connects to the security system panel (e.g., GE Concordpanel). The interface may, for example, implement the Superbus 2000protocol, which can then be utilized by the more comprehensivetransaction-level security functions implemented in PanelConnecttechnology (e.g SetAlarmLevel (int level, int partition, char*accessCode)). Power control drivers are also provided.

FIG. 7 is a block diagram of a touchscreen 700 of the integratedsecurity system, under an embodiment. The touchscreen 700 generallyincludes an application/presentation layer 702 with a residentapplication 704, and a core engine 706. The touchscreen 700 alsoincludes one or more of the following, but is not so limited:applications of premium services 710, widgets 712, a caching proxy 714,network security 716, network interface 718, security object 720,applications supporting devices 722, PanelConnect API 724, a gatewayinterface 726, and one or more ports 728.

More specifically, the touchscreen, when configured as a home securitydevice, includes but is not limited to the following application orsoftware modules: RS 485 and/or RS-232 bus security protocols toconventional home security system panel (e.g., GE Concord panel);functional home security classes and interfaces (e.g. Panel ARM state,Sensor status, etc.); Application/Presentation layer or engine; ResidentApplication; Consumer Home Security Application; installer home securityapplication; core engine; and System bootloader/Software Updater. Thecore Application engine and system bootloader can also be used tosupport other advanced content and applications. This provides aseamless interaction between the premise security application and otheroptional services such as weather widgets or IP cameras.

An alternative configuration of the touchscreen includes a firstApplication engine for premise security and a second Application enginefor all other applications. The integrated security system applicationengine supports content standards such as HTML, XML, Flash, etc. andenables a rich consumer experience for all ‘widgets’, whethersecurity-based or not. The touchscreen thus provides service providersthe ability to use web content creation and management tools to buildand download any ‘widgets’ regardless of their functionality.

As discussed above, although the Security Applications have specificlow-level functional requirements in order to interface with the premisesecurity system, these applications make use of the same fundamentalapplication facilities as any other ‘widget’, application facilitiesthat include graphical layout, interactivity, application handoff,screen management, and network interfaces, to name a few.

Content management in the touchscreen provides the ability to leverageconventional web development tools, performance optimized for anembedded system, service provider control of accessible content, contentreliability in a consumer device, and consistency between ‘widgets’ andseamless widget operational environment. In an embodiment of theintegrated security system, widgets are created by web developers andhosted on the integrated security system Content Manager (and stored inthe Content Store database). In this embodiment the server componentcaches the widgets and offers them to consumers through the web-basedintegrated security system provisioning system. The servers interactwith the advanced touchscreen using HTTPS interfaces controlled by thecore engine and dynamically download widgets and updates as needed to becached on the touchscreen. In other embodiments widgets can be accesseddirectly over a network such as the Internet without needing to gothrough the iControl Content Manager

Referring to FIG. 7, the touchscreen system is built on a tieredarchitecture, with defined interfaces between theApplication/Presentation Layer (the Application Engine) on the top, theCore Engine in the middle, and the security panel and gateway APIs atthe lower level. The architecture is configured to provide maximumflexibility and ease of maintenance.

The application engine of the touchscreen provides the presentation andinteractivity capabilities for all applications (widgets) that run onthe touchscreen, including both core security function widgets and thirdparty content widgets. FIG. 8 is an example screenshot 800 of anetworked security touchscreen, under an embodiment. This examplescreenshot 800 includes three interfaces or user interface (UI)components 802-806, but is not so limited. A first UI 802 of thetouchscreen includes icons by which a user controls or accessesfunctions and/or components of the security system (e.g., “Main”,“Panic”, “Medic”, “Fire”, state of the premise alarm system (e.g.,disarmed, armed, etc.), etc.); the first UI 802, which is also referredto herein as a security interface, is always presented on thetouchscreen. A second UI 804 of the touchscreen includes icons by whicha user selects or interacts with services and other network content(e.g., clock, calendar, weather, stocks, news, sports, photos, maps,music, etc.) that is accessible via the touchscreen. The second UI 804is also referred to herein as a network interface or content interface.A third UI 806 of the touchscreen includes icons by which a user selectsor interacts with additional services or components (e.g., intercomcontrol, security, cameras coupled to the system in particular regions(e.g., front door, baby, etc.) available via the touchscreen.

A component of the application engine is the Presentation Engine, whichincludes a set of libraries that implement the standards-based widgetcontent (e.g., XML, HTML, JavaScript, Flash) layout and interactivity.This engine provides the widget with interfaces to dynamically load bothgraphics and application logic from third parties, support high leveldata description language as well as standard graphic formats. The setof web content-based functionality available to a widget developer isextended by specific touchscreen functions implemented as local webservices by the Core Engine.

The resident application of the touchscreen is the master service thatcontrols the interaction of all widgets in the system, and enforces thebusiness and security rules required by the service provider. Forexample, the resident application determines the priority of widgets,thereby enabling a home security widget to override resource requestsfrom a less critical widget (e.g. a weather widget). The residentapplication also monitors widget behavior, and responds to client orserver requests for cache updates.

The core engine of the touchscreen manages interaction with othercomponents of the integrated security system, and provides an interfacethrough which the resident application and authorized widgets can getinformation about the home security system, set alarms, install sensors,etc. At the lower level, the Core Engine's main interactions are throughthe PanelConnect API, which handles all communication with the securitypanel, and the gateway Interface, which handles communication with thegateway. In an embodiment, both the iHub Interface and PanelConnect APIare resident and operating on the touchscreen. In another embodiment,the PanelConnect API runs on the gateway or other device that providessecurity system interaction and is accessed by the touchscreen through aweb services interface.

The Core Engine also handles application and service level persistentand cached memory functions, as well as the dynamic provisioning ofcontent and widgets, including but not limited to: flash memorymanagement, local widget and content caching, widget version management(download, cache flush new/old content versions), as well as the cachingand synchronization of user preferences. As a portion of these servicesthe Core engine incorporates the bootloader functionality that isresponsible for maintaining a consistent software image on thetouchscreen, and acts as the client agent for all software updates. Thebootloader is configured to ensure full update redundancy so thatunsuccessful downloads cannot corrupt the integrated security system.

Video management is provided as a set of web services by the CoreEngine. Video management includes the retrieval and playback of localvideo feeds as well as remote control and management of cameras (allthrough iControl CameraConnect technology).

Both the high level application layer and the mid-level core engine ofthe touchscreen can make calls to the network. Any call to the networkmade by the application layer is automatically handed off to a localcaching proxy, which determines whether the request should be handledlocally. Many of the requests from the application layer are webservices API requests, although such requests could be satisfied by theiControl servers, they are handled directly by the touchscreen and thegateway. Requests that get through the caching proxy are checked againsta white list of acceptable sites, and, if they match, are sent offthrough the network interface to the gateway. Included in the NetworkSubsystem is a set of network services including HTTP, HTTPS, andserver-level authentication functions to manage the secure client-serverinterface. Storage and management of certificates is incorporated as apart of the network services layer.

Server components of the integrated security system servers supportinteractive content services on the touchscreen. These server componentsinclude, but are not limited to the content manager, registry manager,network manager, and global registry, each of which is described herein.

The Content Manager oversees aspects of handling widget data and rawcontent on the touchscreen. Once created and validated by the serviceprovider, widgets are ‘ingested’ to the Content Manager, and then becomeavailable as downloadable services through the integrated securitysystem Content Management APIs. The Content manager maintains versionsand timestamp information, and connects to the raw data contained in thebackend Content Store database. When a widget is updated (or new contentbecomes available) all clients registering interest in a widget aresystematically updated as needed (a process that can be configured at anaccount, locale, or system-wide level).

The Registry Manager handles user data, and provisioning accounts,including information about widgets the user has decided to install, andthe user preferences for these widgets.

The Network Manager handles getting and setting state for all devices onthe integrated security system network (e.g., sensors, panels, cameras,etc.). The Network manager synchronizes with the gateway, the advancedtouchscreen, and the subscriber database.

The Global Registry is a primary starting point server for all clientservices, and is a logical referral service that abstracts specificserver locations/addresses from clients (touchscreen, gateway 102,desktop widgets, etc.). This approach enables easy scaling/migration ofserver farms.

The touchscreen of an embodiment operates wirelessly with a premisesecurity system. The touchscreen of an embodiment incorporates an RFtransceiver component that either communicates directly with the sensorsand/or security panel over the panel's proprietary RF frequency, or thetouchscreen communicates wirelessly to the gateway over 802.11,Ethernet, or other IP-based communications channel, as described indetail herein. In the latter case the gateway implements thePanelConnect interface and communicates directly to the security paneland/or sensors over wireless or wired networks as described in detailabove.

The touchscreen of an embodiment is configured to operate with multiplesecurity systems through the use of an abstracted security systeminterface. In this embodiment, the PanelConnect API can be configured tosupport a plurality of proprietary security system interfaces, eithersimultaneously or individually as described herein. In one embodiment ofthis approach, the touchscreen incorporates multiple physical interfacesto security panels (e.g. GE Security RS-485, Honeywell RF, etc.) inaddition to the PanelConnect API implemented to support multiplesecurity interfaces. The change needed to support this in PanelConnectis a configuration parameter specifying the panel type connection thatis being utilized.

So for example, the setARMState( ) function is called with an additionalparameter (e.g., Armstate=setARMState(type=“ARM STAY|ARM AWAY|DISARM”,Parameters=“ExitDelay=30|Lights=OFF”, panelType=“GE Concord4 RS485”)).The ‘panelType’ parameter is used by the setARMState function (and inpractice by all of the PanelConnect functions) to select an algorithmappropriate to the specific panel out of a plurality of algorithms.

The touchscreen of an embodiment is self-installable. Consequently, thetouchscreen provides a ‘wizard’ approach similar to that used intraditional computer installations (e.g. InstallShield). The wizard canbe resident on the touchscreen, accessible through a web interface, orboth. In one embodiment of a touchscreen self-installation process, theservice provider can associate devices (sensors, touchscreens, securitypanels, lighting controls, etc.) remotely using a web-basedadministrator interface.

The touchscreen of an embodiment includes a battery backup system for asecurity touchscreen. The touchscreen incorporates a standard Li-ion orother battery and charging circuitry to allow continued operation in theevent of a power outage. In an embodiment the battery is physicallylocated and connected within the touchscreen enclosure. In anotherembodiment the battery is located as a part of the power transformer, orin between the power transformer and the touchscreen.

The example configurations of the integrated security system describedabove with reference to FIGS. 5 and 6 include a gateway that is aseparate device, and the touchscreen couples to the gateway. However, inan alternative embodiment, the gateway device and its functionality canbe incorporated into the touchscreen so that the device managementmodule, which is now a component of or included in the touchscreen, isin charge of the discovery, installation and configuration of the IPdevices coupled or connected to the system, as described above. Theintegrated security system with the integrated touchscreen/gateway usesthe same “sandbox” network to discover and manage all IP devices coupledor connected as components of the system.

The touchscreen of this alternative embodiment integrates the componentsof the gateway with the components of the touchscreen as describedherein. More specifically, the touchscreen of this alternativeembodiment includes software or applications described above withreference to FIG. 3. In this alternative embodiment, the touchscreenincludes the gateway application layer 302 as the main program thatorchestrates the operations performed by the gateway. A Security Engine304 of the touchscreen provides robust protection against intentionaland unintentional intrusion into the integrated security system networkfrom the outside world (both from inside the premises as well as fromthe WAN). The Security Engine 304 of an embodiment comprises one or moresub-modules or components that perform functions including, but notlimited to, the following:

-   -   Encryption including 128-bit SSL encryption for gateway and        iConnect server communication to protect user data privacy and        provide secure communication.    -   Bi-directional authentication between the touchscreen and        iConnect server in order to prevent unauthorized spoofing and        attacks. Data sent from the iConnect server to the gateway        application (or vice versa) is digitally signed as an additional        layer of security. Digital signing provides both authentication        and validation that the data has not been altered in transit.    -   Camera SSL encapsulation because picture and video traffic        offered by off-the-shelf networked IP cameras is not secure when        traveling over the Internet. The touchscreen provides for        128-bit SSL encapsulation of the user picture and video data        sent over the internet for complete user security and privacy.    -   802.11b/g/n with WPA-2 security to ensure that wireless camera        communications always takes place using the strongest available        protection.    -   A touchscreen-enabled device is assigned a unique activation key        for activation with an iConnect server. This ensures that only        valid gateway-enabled devices can be activated for use with the        specific instance of iConnect server in use. Attempts to        activate gateway-enabled devices by brute force are detected by        the Security Engine. Partners deploying touchscreen-enabled        devices have the knowledge that only a gateway with the correct        serial number and activation key can be activated for use with        an iConnect server. Stolen devices, devices attempting to        masquerade as gateway-enabled devices, and malicious outsiders        (or insiders as knowledgeable but nefarious customers) cannot        effect other customers' gateway-enabled devices.

As standards evolve, and new encryption and authentication methods areproven to be useful, and older mechanisms proven to be breakable, thesecurity manager can be upgraded “over the air” to provide new andbetter security for communications between the iConnect server and thegateway application, and locally at the premises to remove any risk ofeavesdropping on camera communications.

A Remote Firmware Download module 306 of the touchscreen allows forseamless and secure updates to the gateway firmware through the iControlMaintenance Application on the server 104, providing a transparent,hassle-free mechanism for the service provider to deploy new featuresand bug fixes to the installed user base. The firmware downloadmechanism is tolerant of connection loss, power interruption and userinterventions (both intentional and unintentional). Such robustnessreduces down time and customer support issues. Touchscreen firmware canbe remotely download either for one touchscreen at a time, a group oftouchscreen, or in batches.

The Automations engine 308 of the touchscreen manages the user-definedrules of interaction between the different devices (e.g. when door opensturn on the light). Though the automation rules are programmed andreside at the portal/server level, they are cached at the gateway levelin order to provide short latency between device triggers and actions.

DeviceConnect 310 of the touchscreen touchscreen includes definitions ofall supported devices (e.g., cameras, security panels, sensors, etc.)using a standardized plug-in architecture. The DeviceConnect module 310offers an interface that can be used to quickly add support for any newdevice as well as enabling interoperability between devices that usedifferent technologies/protocols. For common device types, pre-definedsub-modules have been defined, making supporting new devices of thesetypes even easier. SensorConnect 312 is provided for adding new sensors,CameraConnect 316 for adding IP cameras, and PanelConnect 314 for addinghome security panels.

The Schedules engine 318 of the touchscreen is responsible for executingthe user defined schedules (e.g., take a picture every five minutes;every day at 8 am set temperature to 65 degrees Fahrenheit, etc.).Though the schedules are programmed and reside at the iConnect serverlevel they are sent to the scheduler within the gateway application ofthe touchscreen. The Schedules Engine 318 then interfaces withSensorConnect 312 to ensure that scheduled events occur at precisely thedesired time.

The Device Management module 320 of the touchscreen is in charge of alldiscovery, installation and configuration of both wired and wireless IPdevices (e.g., cameras, etc.) coupled or connected to the system.Networked IP devices, such as those used in the integrated securitysystem, require user configuration of many IP and security parameters,and the device management module of an embodiment handles the details ofthis configuration. The device management module also manages the videorouting module described below.

The video routing engine 322 of the touchscreen is responsible fordelivering seamless video streams to the user with zero-configuration.Through a multi-step, staged approach the video routing engine uses acombination of UPnP port-forwarding, relay server routing and STUN/TURNpeer-to-peer routing. The video routing engine is described in detail inthe Related Applications.

FIG. 9 is a block diagram 900 of network or premise device integrationwith a premise network 250, under an embodiment. In an embodiment,network devices 255, 256, 957 are coupled to the touchscreen 902 using asecure network connection such as SSL over an encrypted 802.11 link(utilizing for example WPA-2 security for the wireless encryption), andthe touchscreen 902 coupled to the premise router/firewall 252 via acoupling with a premise LAN 250. The premise router/firewall 252 iscoupled to a broadband modem 251, and the broadband modem 251 is coupledto a WAN 200 or other network outside the premise. The touchscreen 902thus enables or forms a separate wireless network, or sub-network, thatincludes some number of devices and is coupled or connected to the LAN250 of the host premises. The touchscreen sub-network can include, butis not limited to, any number of other devices like WiFi IP cameras,security panels (e.g., IP-enabled), and IP devices, to name a few. Thetouchscreen 902 manages or controls the sub-network separately from theLAN 250 and transfers data and information between components of thesub-network and the LAN 250/WAN 200, but is not so limited.Additionally, other network devices 254 can be coupled to the LAN 250without being coupled to the touchscreen 902.

FIG. 10 is a block diagram 1000 of network or premise device integrationwith a premise network 250, under an alternative embodiment. The networkor premise devices 255, 256, 1057 are coupled to the touchscreen 1002,and the touchscreen 1002 is coupled or connected between the premiserouter/firewall 252 and the broadband modem 251. The broadband modem 251is coupled to a WAN 200 or other network outside the premise, while thepremise router/firewall 252 is coupled to a premise LAN 250. As a resultof its location between the broadband modem 251 and the premiserouter/firewall 252, the touchscreen 1002 can be configured or functionas the premise router routing specified data between the outside network(e.g., WAN 200) and the premise router/firewall 252 of the LAN 250. Asdescribed above, the touchscreen 1002 in this configuration enables orforms a separate wireless network, or sub-network, that includes thenetwork or premise devices 255, 156, 1057 and is coupled or connectedbetween the LAN 250 of the host premises and the WAN 200. Thetouchscreen sub-network can include, but is not limited to, any numberof network or premise devices 255, 256, 1057 like WiFi IP cameras,security panels (e.g., IP-enabled), and security touchscreens, to name afew. The touchscreen 1002 manages or controls the sub-network separatelyfrom the LAN 250 and transfers data and information between componentsof the sub-network and the LAN 250/WAN 200, but is not so limited.Additionally, other network devices 254 can be coupled to the LAN 250without being coupled to the touchscreen 1002.

The gateway of an embodiment, whether a stand-along component orintegrated with a touchscreen, enables couplings or connections and thusthe flow or integration of information between various components of thehost premises and various types and/or combinations of IP devices, wherethe components of the host premises include a network (e.g., LAN) and/ora security system or subsystem to name a few. Consequently, the gatewaycontrols the association between and the flow of information or databetween the components of the host premises. For example, the gateway ofan embodiment forms a sub-network coupled to another network (e.g., WAN,LAN, etc.), with the sub-network including IP devices. The gatewayfurther enables the association of the IP devices of the sub-networkwith appropriate systems on the premises (e.g., security system, etc.).Therefore, for example, the gateway can form a sub-network of IP devicesconfigured for security functions, and associate the sub-network onlywith the premises security system, thereby segregating the IP devicesdedicated to security from other IP devices that may be coupled toanother network on the premises.

The gateway of an embodiment, as described herein, enables couplings orconnections and thus the flow of information between various componentsof the host premises and various types and/or combinations of IPdevices, where the components of the host premises include a network, asecurity system or subsystem to name a few. Consequently, the gatewaycontrols the association between and the flow of information or databetween the components of the host premises. For example, the gateway ofan embodiment forms a sub-network coupled to another network (e.g., WAN,LAN, etc.), with the sub-network including IP devices. The gatewayfurther enables the association of the IP devices of the sub-networkwith appropriate systems on the premises (e.g., security system, etc.).Therefore, for example, the gateway can form a sub-network of IP devicesconfigured for security functions, and associate the sub-network onlywith the premises security system, thereby segregating the IP devicesdedicated to security from other IP devices that may be coupled toanother network on the premises.

FIG. 11 is a flow diagram for a method 1100 of forming a securitynetwork including integrated security system components, under anembodiment. Generally, the method comprises coupling 1102 a gatewaycomprising a connection management component to a local area network ina first location and a security server in a second location. The methodcomprises forming 1104 a security network by automatically establishinga wireless coupling between the gateway and a security system using theconnection management component. The security system of an embodimentcomprises security system components located at the first location. Themethod comprises integrating 1106 communications and functions of thesecurity system components into the security network via the wirelesscoupling.

FIG. 12 is a flow diagram for a method 1200 of forming a securitynetwork including integrated security system components and networkdevices, under an embodiment. Generally, the method comprises coupling1202 a gateway to a local area network located in a first location and asecurity server in a second location. The method comprises automaticallyestablishing 1204 communications between the gateway and security systemcomponents at the first location, the security system including thesecurity system components. The method comprises automaticallyestablishing 1206 communications between the gateway and premise devicesat the first location. The method comprises forming 1208 a securitynetwork by electronically integrating, via the gateway, communicationsand functions of the premise devices and the security system components.

In an example embodiment, FIG. 13 is a flow diagram 1300 for integrationor installation of an IP device into a private network environment,under an embodiment. The IP device includes any IP-capable device that,for example, includes the touchscreen of an embodiment. The variables ofan embodiment set at time of installation include, but are not limitedto, one or more of a private SSID/Password, a gateway identifier, asecurity panel identifier, a user account TS, and a Central MonitoringStation account identification.

An embodiment of the IP device discovery and management begins with auser or installer activating 1302 the gateway and initiating 1304 theinstall mode of the system. This places the gateway in an install mode.Once in install mode, the gateway shifts to a default (Install) Wificonfiguration. This setting will match the default setting for otherintegrated security system-enabled devices that have been pre-configuredto work with the integrated security system. The gateway will then beginto provide 1306 DHCP addresses for these IP devices. Once the deviceshave acquired a new DHCP address from the gateway, those devices areavailable for configuration into a new secured Wifi network setting.

The user or installer of the system selects 1308 all devices that havebeen identified as available for inclusion into the integrated securitysystem. The user may select these devices by their unique IDs via a webpage, Touchscreen, or other client interface. The gateway provides 1310data as appropriate to the devices. Once selected, the devices areconfigured 1312 with appropriate secured Wifi settings, including SSIDand WPA/WPA-2 keys that are used once the gateway switches back to thesecured sandbox configuration from the “Install” settings. Othersettings are also configured as appropriate for that type of device.Once all devices have been configured, the user is notified and the usercan exit install mode. At this point all devices will have beenregistered 1314 with the integrated security system servers.

The installer switches 1316 the gateway to an operational mode, and thegateway instructs or directs 1318 all newly configured devices to switchto the “secured” Wifi sandbox settings. The gateway then switches 1320to the “secured” Wifi settings. Once the devices identify that thegateway is active on the “secured” network, they request new DHCPaddresses from the gateway which, in response, provides 1322 the newaddresses. The devices with the new addresses are then operational 1324on the secured network.

In order to ensure the highest level of security on the secured network,the gateway can create or generate a dynamic network securityconfiguration based on the unique ID and private key in the gateway,coupled with a randomizing factor that can be based on online time orother inputs. This guarantees the uniqueness of the gateway securednetwork configuration.

To enable the highest level of performance, the gateway analyzes the RFspectrum of the 802.11x network and determines which frequencyband/channel it should select to run.

An alternative embodiment of the camera/IP device management processleverages the local ethernet connection of the sandbox network on thegateway. This alternative process is similar to the Wifi discoveryembodiment described above, except the user connects the targeted deviceto the ethernet port of the sandbox network to begin the process. Thisalternative embodiment accommodates devices that have not beenpre-configured with the default “Install” configuration for theintegrated security system.

This alternative embodiment of the IP device discovery and managementbegins with the user/installer placing the system into install mode. Theuser is instructed to attach an IP device to be installed to the sandboxEthernet port of the gateway. The IP device requests a DHCP address fromthe gateway which, in response to the request, provides the address. Theuser is presented the device and is asked if he/she wants to install thedevice. If yes, the system configures the device with the secured Wifisettings and other device-specific settings (e.g., camera settings forvideo length, image quality etc.). The user is next instructed todisconnect the device from the ethernet port. The device is nowavailable for use on the secured sandbox network.

FIG. 14 is a block diagram showing communications among integrated IPdevices of the private network environment, under an embodiment. The IPdevices of this example include a security touchscreen 1403, gateway1402 (e.g., “iHub”), and security panel (e.g., “Security Panel 1”,“Security Panel 2”, “Security Panel n”), but the embodiment is not solimited. In alternative embodiments any number and/or combination ofthese three primary component types may be combined with othercomponents including IP devices and/or security system components. Forexample, a single device that comprises an integrated gateway,touchscreen, and security panel is merely another embodiment of theintegrated security system described herein. The description thatfollows includes an example configuration that includes a touchscreenhosting particular applications. However, the embodiment is not limitedto the touchscreen hosting these applications, and the touchscreenshould be thought of as representing any IP device.

Referring to FIG. 14, the touchscreen 1403 incorporates an application1410 that is implemented as computer code resident on the touchscreenoperating system, or as a web-based application running in a browser, oras another type of scripted application (e.g., Flash, Java, VisualBasic, etc.). The touchscreen core application 1410 represents thisapplication, providing user interface and logic for the end user tomanage their security system or to gain access to networked informationor content (Widgets). The touchscreen core application 1410 in turnaccesses a library or libraries of functions to control the localhardware (e.g. screen display, sound, LEDs, memory, etc.) as well asspecialized librarie(s) to couple or connect to the security system.

In an embodiment of this security system connection, the touchscreen1403 communicates to the gateway 1402, and has no direct communicationwith the security panel. In this embodiment, the touchscreen coreapplication 1410 accesses the remote service APIs 1412 which providesecurity system functionality (e.g. ARM/DISARM panel, sensor state,get/set panel configuration parameters, initiate or get alarm events,etc.). In an embodiment, the remote service APIs 1412 implement one ormore of the following functions, but the embodiment is not so limited:Armstate=setARMState(type=“ARM STAY|ARM AWAY|DISARM”,Parameters=“ExitDelay=30|Lights=OFF”); sensorState=getSensors(type=“ALL|SensorName|SensorNameList”); result=setSensorState(SensorName,parameters=“Option1, Options2, . . . Option n”);interruptHandler=SensorEvent( ); and, interruptHandler=alarmEvent( ).

Functions of the remote service APIs 1412 of an embodiment use a remotePanelConnect API 1424 which which resides in memory on the gateway 1402.The touchscreen 1403 communicates with the gateway 1402 through asuitable network interface such as an Ethernet or 802.11 RF connection,for example. The remote PanelConnect API 1424 provides the underlyingSecurity System Interfaces 1426 used to communicate with and control oneor more types of security panel via wired link 1430 and/or RF link 3.The PanelConnect API 1224 provides responses and input to the remoteservices APIs 1426, and in turn translates function calls and data toand from the specific protocols and functions supported by a specificimplementation of a Security Panel (e.g. a GE Security Simon XT orHoneywell Vista 20P). In an embodiment, the PanelConnect API 1224 uses a345 MHz RF transceiver or receiver hardware/firmware module tocommunicate wirelessly to the security panel and directly to a set of345 MHz RF-enabled sensors and devices, but the embodiment is not solimited.

The gateway of an alternative embodiment communicates over a wiredphysical coupling or connection to the security panel using the panel'sspecific wired hardware (bus) interface and the panel's bus-levelprotocol.

In an alternative embodiment, the Touchscreen 1403 implements the samePanelConnect API 1414 locally on the Touchscreen 1403, communicatingdirectly with the Security Panel 2 and/or Sensors 2 over the proprietaryRF link or over a wired link for that system. In this embodiment theTouchscreen 1403, instead of the gateway 1402, incorporates the 345 MHzRF transceiver to communicate directly with Security Panel 2 or Sensors2 over the RF link 2. In the case of a wired link the Touchscreen 1403incorporates the real-time hardware (e.g. a PIC chip and RS232-variantserial link) to physically connect to and satisfy the specific bus-leveltiming requirements of the SecurityPanel2.

In yet another alternative embodiment, either the gateway 1402 or theTouchscreen 1403 implements the remote service APIs. This embodimentincludes a Cricket device (“Cricket”) which comprises but is not limitedto the following components: a processor (suitable for handling 802.11protocols and processing, as well as the bus timing requirements ofSecurityPanel1); an 802.11 (WiFi) client IP interface chip; and, aserial bus interface chip that implements variants of RS232 or RS485,depending on the specific Security Panel.

The Cricket also implements the full PanelConnect APIs such that it canperform the same functions as the case where the gateway implements thePanelConnect APIs. In this embodiment, the touchscreen core application1410 calls functions in the remote service APIs 1412 (such assetArmState( )). These functions in turn couple or connect to the remoteCricket through a standard IP connection (“Cricket IP Link”) (e.g.,Ethernet, Homeplug, the gateway's proprietary Wifi network, etc.). TheCricket in turn implements the PanelConnect API, which responds to therequest from the touchscreen core application, and performs theappropriate function using the proprietary panel interface. Thisinterface uses either the wireless or wired proprietary protocol for thespecific security panel and/or sensors.

FIG. 15 is a flow diagram of a method of integrating an external controland management application system with an existing security system,under an embodiment. Operations begin when the system is powered on1510, involving at a minimum the power-on of the gateway device, andoptionally the power-on of the connection between the gateway device andthe remote servers. The gateway device initiates 1520 a software and RFsequence to locate the extant security system. The gateway and installerinitiate and complete 1530 a sequence to ‘learn’ the gateway into thesecurity system as a valid and authorized control device. The gatewayinitiates 1540 another software and RF sequence of instructions todiscover and learn the existence and capabilities of existing RF deviceswithin the extant security system, and store this information in thesystem. These operations under the system of an embodiment are describedin further detail below.

Unlike conventional systems that extend an existing security system, thesystem of an embodiment operates utilizing the proprietary wirelessprotocols of the security system manufacturer. In one illustrativeembodiment, the gateway is an embedded computer with an IP LAN and WANconnection and a plurality of RF transceivers and software protocolmodules capable of communicating with a plurality of security systemseach with a potentially different RF and software protocol interface.After the gateway has completed the discovery and learning 1540 ofsensors and has been integrated 1550 as a virtual control device in theextant security system, the system becomes operational. Thus, thesecurity system and associated sensors are presented 1550 as accessibledevices to a potential plurality of user interface subsystems.

The system of an embodiment integrates 1560 the functionality of theextant security system with other non-security devices including but notlimited to IP cameras, touchscreens, lighting controls, door lockingmechanisms, which may be controlled via RF, wired, or powerline-basednetworking mechanisms supported by the gateway or servers.

The system of an embodiment provides a user interface subsystem 1570enabling a user to monitor, manage, and control the system andassociated sensors and security systems. In an embodiment of the system,a user interface subsystem is an HTML/XML/Javascript/Java/AJAX/Flashpresentation of a monitoring and control application, enabling users toview the state of all sensors and controllers in the extant securitysystem from a web browser or equivalent operating on a computer, PDA,mobile phone, or other consumer device.

In another illustrative embodiment of the system described herein, auser interface subsystem is an HTML/XML/Javascript/Java/AJAXpresentation of a monitoring and control application, enabling users tocombine the monitoring and control of the extant security system andsensors with the monitoring and control of non-security devicesincluding but not limited to IP cameras, touchscreens, lightingcontrols, door locking mechanisms.

In another illustrative embodiment of the system described herein, auser interface subsystem is a mobile phone application enabling users tomonitor and control the extant security system as well as othernon-security devices.

In another illustrative embodiment of the system described herein, auser interface subsystem is an application running on a keypad ortouchscreen device enabling users to monitor and control the extantsecurity system as well as other non-security devices.

In another illustrative embodiment of the system described herein, auser interface subsystem is an application operating on a TV or set-topbox connected to a TV enabling users to monitor and control the extantsecurity system as well as other non-security devices.

FIG. 16 is a block diagram of an integrated security system 1600wirelessly interfacing to proprietary security systems, under anembodiment. A security system 1610 is coupled or connected to a Gateway1620, and from Gateway 1620 coupled or connected to a plurality ofinformation and content sources across a network 1630 including one ormore web servers 1640, system databases 1650, and applications servers1660. While in one embodiment network 1630 is the Internet, includingthe World Wide Web, those of skill in the art will appreciate thatnetwork 1630 may be any type of network, such as an intranet, anextranet, a virtual private network (VPN), a mobile network, or anon-TCP/IP based network.

Moreover, other elements of the system of an embodiment may beconventional, well-known elements that need not be explained in detailherein. For example, security system 1610 could be any type home orbusiness security system, such devices including but not limited to astandalone RF home security system or a non-RF-capable wired homesecurity system with an add-on RF interface module. In the integratedsecurity system 1600 of this example, security system 1610 includes anRF-capable wireless security panel (WSP) 1611 that acts as the mastercontroller for security system 1610. Well-known examples of such a WSPinclude the GE Security Concord, Networx, and Simon panels, theHoneywell Vista and Lynx panels, and similar panels from DSC and Napco,to name a few. A wireless module 1614 includes the RF hardware andprotocol software necessary to enable communication with and control ofa plurality of wireless devices 1613. WSP 1611 may also manage wireddevices 1614 physically connected to WSP 1611 with an RS232 or RS485 orEthernet connection or similar such wired interface.

In an implementation consistent with the systems and methods describedherein, Gateway 1620 provides the interface between security system 1610and LAN and/or WAN for purposes of remote control, monitoring, andmanagement. Gateway 1620 communicates with an external web server 1640,database 1650, and application server 1660 over network 1630 (which maycomprise WAN, LAN, or a combination thereof). In this example system,application logic, remote user interface functionality, as well as userstate and account are managed by the combination of these remoteservers. Gateway 1620 includes server connection manager 1621, asoftware interface module responsible for all server communication overnetwork 1630. Event manager 1622 implements the main event loop forGateway 1620, processing events received from device manager 1624(communicating with non-security system devices including but notlimited to IP cameras, wireless thermostats, or remote door locks).Event manager 1622 further processes events and control messages fromand to security system 1610 by utilizing WSP manager 1623.

WSP manager 1623 and device manager 1624 both rely upon wirelessprotocol manager 1626 which receives and stores the proprietary orstandards-based protocols required to support security system 1610 aswell as any other devices interfacing with gateway 1620. WSP manager1623 further utilizes the comprehensive protocols and interfacealgorithms for a plurality of security systems 1610 stored in the WSP DBclient database associated with wireless protocol manager 1626. Thesevarious components implement the software logic and protocols necessaryto communicate with and manager devices and security systems 1610.Wireless Transceiver hardware modules 1625 are then used to implementthe physical RF communications link to such devices and security systems1610. An illustrative wireless transceiver 1625 is the GE SecurityDialog circuit board, implementing a 319.5 MHz two-way RF transceivermodule. In this example, RF Link 1670 represents the 319.5 MHz RFcommunication link, enabling gateway 1620 to monitor and control WSP1611 and associated wireless and wired devices 1613 and 1614,respectively.

In one embodiment, server connection manager 1621 requests and receivesa set of wireless protocols for a specific security system 1610 (anillustrative example being that of the GE Security Concord panel andsensors) and stores them in the WSP DB portion of the wireless protocolmanager 1626. WSP manager 1623 then utilizes such protocols fromwireless protocol manager 1626 to initiate the sequence of processesdetailed in FIG. 15 and FIG. 16 for learning gateway 1620 into securitysystem 1610 as an authorized control device. Once learned in, asdescribed with reference to FIG. 16 (and above), event manager 1622processes all events and messages detected by the combination of WSPmanager 1623 and the GE Security wireless transceiver module 1625.

In another embodiment, gateway 1620 incorporates a plurality of wirelesstransceivers 1625 and associated protocols managed by wireless protocolmanager 1626. In this embodiment events and control of multipleheterogeneous devices may be coordinated with WSP 1611, wireless devices1613, and wired devices 1614. For example a wireless sensor from onemanufacturer may be utilized to control a device using a differentprotocol from a different manufacturer.

In another embodiment, gateway 1620 incorporates a wired interface tosecurity system 1610, and incorporates a plurality of wirelesstransceivers 1625 and associated protocols managed by wireless protocolmanager 1626. In this embodiment events and control of multipleheterogeneous devices may be coordinated with WSP 1611, wireless devices1613, and wired devices 1614.

Of course, while an illustrative embodiment of an architecture of thesystem of an embodiment is described in detail herein with respect toFIG. 16, one of skill in the art will understand that modifications tothis architecture may be made without departing from the scope of thedescription presented herein. For example, the functionality describedherein may be allocated differently between client and server, oramongst different server or processor-based components. Likewise, theentire functionality of the gateway 1620 described herein could beintegrated completely within an existing security system 1610. In suchan embodiment, the architecture could be directly integrated with asecurity system 1610 in a manner consistent with the currently describedembodiments.

FIG. 17 is a flow diagram for wirelessly ‘learning’ the Gateway into anexisting security system and discovering extant sensors, under anembodiment. The learning interfaces gateway 1620 with security system1610. Gateway 1620 powers up 1710 and initiates software sequences 1720and 1725 to identify accessible WSPs 1611 and wireless devices 1613,respectively (e.g., one or more WSPs and/or devices within range ofgateway 1620). Once identified, WSP 1611 is manually or automaticallyset into ‘learn mode’ 1730, and gateway 1620 utilizes availableprotocols to add 1740 itself as an authorized control device in securitysystem 1610. Upon successful completion of this task, WSP 1611 ismanually or automatically removed from ‘learn mode’ 1750.

Gateway 1620 utilizes the appropriate protocols to mimic 1760 the firstidentified device 1614. In this operation gateway 1620 identifies itselfusing the unique or pseudo-unique identifier of the first found device1614, and sends an appropriate change of state message over RF Link1670. In the event that WSP 1611 responds to this change of statemessage, the device 1614 is then added 1770 to the system in database1650. Gateway 1620 associates 1780 any other information (such as zonename or token-based identifier) with this device 1614 in database 1650,enabling gateway 1620, user interface modules, or any application toretrieve this associated information.

In the event that WSP 1611 does not respond to the change of statemessage, the device 1614 is not added 1770 to the system in database1650, and this device 1614 is identified as not being a part of securitysystem 1610 with a flag, and is either ignored or added as anindependent device, at the discretion of the system provisioning rules.Operations hereunder repeat 1785 operations 1760, 1770, 1780 for alldevices 1614 if applicable. Once all devices 1614 have been tested inthis way, the system begins operation 1790.

In another embodiment, gateway 1620 utilizes a wired connection to WSP1611, but also incorporates a wireless transceiver 1625 to communicatedirectly with devices 1614. In this embodiment, operations under 1720above are removed, and operations under 1740 above are modified so thesystem of this embodiment utilizes wireline protocols to add itself asan authorized control device in security system 1610.

A description of an example embodiment follows in which the Gateway(FIG. 16, element 1620) is the iHub available from iControl Networks,Palo Alto, Calif., and described in detail herein. In this example thegateway is “automatically” installed with a security system.

The automatic security system installation begins with the assignment ofan authorization key to components of the security system (e.g.,gateway, kit including the gateway, etc.). The assignment of anauthorization key is done in lieu of creating a user account. Aninstaller later places the gateway in a user's premises along with thepremises security system. The installer uses a computer to navigate to aweb portal (e.g., integrated security system web interface), logs in tothe portal, and enters the authorization key of the installed gatewayinto the web portal for authentication. Once authenticated, the gatewayautomatically discovers devices at the premises (e.g., sensors, cameras,light controls, etc.) and adds the discovered devices to the system or“network”. The installer assigns names to the devices, and testsoperation of the devices back to the server (e.g., did the door open,did the camera take a picture, etc.). The security device information isoptionally pushed or otherwise propagated to a security panel and/or tothe server network database. The installer finishes the installation,and instructs the end user on how to create an account, username, andpassword. At this time the user enters the authorization key whichvalidates the account creation (uses a valid authorization key toassociate the network with the user's account). New devices maysubsequently be added to the security network in a variety of ways(e.g., user first enters a unique ID for each device/sensor and names itin the server, after which the gateway can automatically discover andconfigure the device).

A description of another example embodiment follows in which thesecurity system (FIG. 16, element 1610) is a Dialog system and the WSP(FIG. 16, element 1611) is a SimonXT available from General ElectricSecurity, and the Gateway (FIG. 16, element 1620) is the iHub availablefrom iControl Networks, Palo Alto, Calif., and described in detailherein. Descriptions of the install process for the SimonXT and iHub arealso provided below.

GE Security's Dialog network is one of the most widely deployed andtested wireless security systems in the world. The physical RF networkis based on a 319.5 MHz unlicensed spectrum, with a bandwidth supportingup to 19 Kbps communications. Typical use of this bandwidth—even inconjunction with the integrated security system—is far less than that.Devices on this network can support either one-way communication (eithera transmitter or a receiver) or two-way communication (a transceiver).Certain GE Simon, Simon XT, and Concord security control panelsincorporate a two-way transceiver as a standard component. The gatewayalso incorporates the same two-way transceiver card. The physical linklayer of the network is managed by the transceiver module hardware andfirmware, while the coded payload bitstreams are made available to theapplication layer for processing.

Sensors in the Dialog network typically use a 60-bit protocol forcommunicating with the security panel transceiver, while security systemkeypads and the gateway use the encrypted 80-bit protocol. The Dialognetwork is configured for reliability, as well as low-power usage. Manydevices are supervised, i.e. they are regularly monitored by the system‘master’ (typically a GE security panel), while still maintainingexcellent power usage characteristics. A typical door window sensor hasa battery life in excess of 5-7 years.

The gateway has two modes of operation in the Dialog network: a firstmode of operation is when the gateway is configured or operates as a‘slave’ to the GE security panel; a second mode of operation is when thegateway is configured or operates as a ‘master’ to the system in theevent a security panel is not present. In both configurations, thegateway has the ability to ‘listen’ to network traffic, enabling thegateway to continually keep track of the status of all devices in thesystem. Similarly, in both situations the gateway can address andcontrol devices that support setting adjustments (such as the GEwireless thermostat).

In the configuration in which the gateway acts as a ‘slave’ to thesecurity panel, the gateway is ‘learned into’ the system as a GEwireless keypad. In this mode of operation, the gateway emulates asecurity system keypad when managing the security panel, and can querythe security panel for status and ‘listen’ to security panel events(such as alarm events).

The gateway incorporates an RF Transceiver manufactured by GE Security,but is not so limited. This transceiver implements the Dialog protocolsand handles all network message transmissions, receptions, and timing.As such, the physical, link, and protocol layers of the communicationsbetween the gateway and any GE device in the Dialog network are totallycompliant with GE Security specifications.

At the application level, the gateway emulates the behavior of a GEwireless keypad utilizing the GE Security 80-bit encrypted protocol, andonly supported protocols and network traffic are generated by thegateway. Extensions to the Dialog RF protocol of an embodiment enablefull control and configuration of the panel, and iControl can bothautomate installation and sensor enrollment as well as directconfiguration downloads for the panel under these protocol extensions.

As described above, the gateway participates in the GE Security networkat the customer premises. Because the gateway has intelligence and atwo-way transceiver, it can ‘hear’ all of the traffic on that network.The gateway makes use of the periodic sensor updates, state changes, andsupervisory signals of the network to maintain a current state of thepremises. This data is relayed to the integrated security system server(e.g., FIG. 2, element 260) and stored in the event repository for useby other server components. This usage of the GE Security RF network iscompletely non-invasive; there is no new data traffic created to supportthis activity.

The gateway can directly (or indirectly through the Simon XT panel)control two-way devices on the network. For example, the gateway candirect a GE Security Thermostat to change its setting to ‘Cool’ from‘Off’, as well as request an update on the current temperature of theroom. The gateway performs these functions using the existing GE Dialogprotocols, with little to no impact on the network; a gateway devicecontrol or data request takes only a few dozen bytes of data in anetwork that can support 19 Kbps.

By enrolling with the Simon XT as a wireless keypad, as describedherein, the gateway includes data or information of all alarm events, aswell as state changes relevant to the security panel. This informationis transferred to the gateway as encrypted packets in the same way thatthe information is transferred to all other wireless keypads on thenetwork.

Because of its status as an authorized keypad, the gateway can alsoinitiate the same panel commands that a keypad can initiate. Forexample, the gateway can arm or disarm the panel using the standardDialog protocol for this activity. Other than the monitoring of standardalarm events like other network keypads, the only incremental datatraffic on the network as a result of the gateway is the infrequentremote arm/disarm events that the gateway initiates, or infrequentqueries on the state of the panel.

The gateway is enrolled into the Simon XT panel as a ‘slave’ devicewhich, in an embodiment, is a wireless keypad. This enables the gatewayfor all necessary functionality for operating the Simon XT systemremotely, as well as combining the actions and information ofnon-security devices such as lighting or door locks with GE Securitydevices. The only resource taken up by the gateway in this scenario isone wireless zone (sensor ID).

The gateway of an embodiment supports three forms of sensor and panelenrollment/installation into the integrated security system, but is notlimited to this number of enrollment/installation options. Theenrollment/installation options of an embodiment include installerinstallation, kitting, and panel, each of which is described below.

Under the installer option, the installer enters the sensor IDs at timeof installation into the integrated security system web portal oriScreen. This technique is supported in all configurations andinstallations.

Kits can be pre-provisioned using integrated security systemprovisioning applications when using the kitting option. At kittingtime, multiple sensors are automatically associated with an account, andat install time there is no additional work required.

In the case where a panel is installed with sensors already enrolled(i.e. using the GE Simon XT enrollment process), the gateway has thecapability to automatically extract the sensor information from thesystem and incorporate it into the user account on the integratedsecurity system server.

The gateway and integrated security system of an embodiment uses anauto-learn process for sensor and panel enrollment in an embodiment. Thedeployment approach of an embodiment can use additional interfaces thatGE Security is adding to the Simon XT panel. With these interfaces, thegateway has the capability to remotely enroll sensors in the panelautomatically. The interfaces include, but are not limited to, thefollowing: EnrollDevice(ID, type, name, zone, group);SetDeviceParameters(ID, type, Name, zone, group),GetDeviceParameters(zone); and RemoveDevice(zone).

The integrated security system incorporates these new interfaces intothe system, providing the following install process. The install processcan include integrated security system logistics to handle kitting andpre-provisioning. Pre-kitting and logistics can include apre-provisioning kitting tool provided by integrated security systemthat enables a security system vendor or provider (“provider”) to offerpre-packaged initial ‘kits’. This is not required but is recommended forsimplifying the install process. This example assumes a ‘Basic’ kit ispreassembled and includes one (1) Simon XT, three (3) Door/windowsensors, one (1) motion sensor, one (1) gateway, one (1) keyfob, two (2)cameras, and ethernet cables. The kit also includes a sticker page withall Zones (1-24) and Names (full name list).

The provider uses the integrated security system kitting tool toassemble ‘Basic’ kit packages. The contents of different types ofstarter kits may be defined by the provider. At the distributionwarehouse, a worker uses a bar code scanner to scan each sensor and thegateway as it is packed into the box. An ID label is created that isattached to the box. The scanning process automatically associates allthe devices with one kit, and the new ID label is the unique identifierof the kit. These boxes are then sent to the provider for distributionto installer warehouses. Individual sensors, cameras, etc. are also sentto the provider installer warehouse. Each is labeled with its ownbarcode/ID.

An installation and enrollment procedure of a security system includinga gateway is described below as one example of the installation process.

-   1. Order and Physical Install Process    -   a. Once an order is generated in the iControl system, an account        is created and an install ticket is created and sent        electronically to the provider for assignment to an installer.    -   b. The assigned installer picks up his/her ticket(s) and fills        his/her truck with Basic and/or Advanced starter kits. He/she        also keeps a stock of individual sensors, cameras, iHubs, Simon        XTs, etc. Optionally, the installer can also stock homeplug        adapters for problematic installations.    -   c. The installer arrives at the address on the ticket, and pulls        out the Basic kit. The installer determines sensor locations        from a tour of the premises and discussion with the homeowner.        At this point assume the homeowner requests additional equipment        including an extra camera, two (2) additional door/window        sensors, one (1) glass break detector, and one (1) smoke        detector.    -   d. Installer mounts SimonXT in the kitchen or other location in        the home as directed by the homeowner, and routes the phone line        to Simon XT if available. GPRS and Phone numbers pre-programmed        in SimonXT to point to the provider Central Monitoring Station        (CMS).    -   e. Installer places gateway in the home in the vicinity of a        router and cable modem. Installer installs an ethernet line from        gateway to router and plugs gateway into an electrical outlet.-   2. Associate and Enroll gateway into SimonXT    -   a. Installer uses either his/her own laptop plugged into router,        or homeowners computer to go to the integrated security system        web interface and log in with installer ID/pass.    -   b. Installer enters ticket number into admin interface, and        clicks ‘New Install’ button. Screen prompts installer for kit ID        (on box's barcode label).    -   c. Installer clicks ‘Add SimonXT’. Instructions prompt installer        to put Simon XT into install mode, and add gateway as a wireless        keypad. It is noted that this step is for security only and can        be automated in an embodiment.    -   d. Installer enters the installer code into the Simon XT.        Installer Learns ‘gateway’ into the panel as a wireless keypad        as a group 1 device.    -   e. Installer goes back to Web portal, and clicks the ‘Finished        Adding SimonXT’ button.-   3. Enroll Sensors into SimonXT via iControl    -   a. All devices in the Basic kit are already associated with the        user's account.    -   b. For additional devices, Installer clicks ‘Add Device’ and        adds the additional camera to the user's account (by typing in        the camera ID/Serial #)    -   c. Installer clicks ‘Add Device’ and adds other sensors (two (2)        door/window sensors, one (1) glass break sensor, and one (1)        smoke sensor) to the account (e.g., by typing in IDs).    -   d. As part of Add Device, Installer assigns zone, name, and        group to the sensor. Installer puts appropriate Zone and Name        sticker on the sensor temporarily.    -   e. All sensor information for the account is pushed or otherwise        propagated to the iConnect server, and is available to propagate        to CMS automation software through the CMS application        programming interface (API).    -   f. Web interface displays ‘Installing Sensors in System . . . ’        and automatically adds all of the sensors to the Simon XT panel        through the GE RF link.    -   g. Web interface displays ‘Done Installing’→all sensors show        green.-   4. Place and Tests Sensors in Home    -   a. Installer physically mounts each sensor in its desired        location, and removes the stickers.    -   b. Installer physically mounts WiFi cameras in their location        and plugs into AC power. Optional fishing of low voltage wire        through wall to remove dangling wires. Camera transformer is        still plugged into outlet but wire is now inside the wall.    -   c. Installer goes to Web interface and is prompted for automatic        camera install. Each camera is provisioned as a private,        encrypted Wifi device on the gateway secured sandbox network,        and firewall NAT traversal is initiated. Upon completion the        customer is prompted to test the security system.    -   d. Installer selects the ‘Test System’ button on the web        portal—the SimonXT is put into Test mode by the gateway over GE        RF.    -   e. Installer manually tests the operation of each sensor,        receiving an audible confirmation from SimonXT.    -   f. gateway sends test data directly to CMS over broadband link,        as well as storing the test data in the user's account for        subsequent report generation.    -   g. Installer exits test mode from the Web portal.-   5. Installer instructs customer on use of the Simon XT, and shows    customer how to log into the iControl web and mobile portals.    Customer creates a username/password at this time.-   6. Installer instructs customer how to change Simon XT user code    from the Web interface. Customer changes user code which is pushed    to SimonXT automatically over GE RF.

An installation and enrollment procedure of a security system includinga gateway is described below as an alternative example of theinstallation process. This installation process is for use for enrollingsensors into the SimonXT and integrated security system and iscompatible with all existing GE Simon panels.

The integrated security system supports all pre-kitting functionalitydescribed in the installation process above. However, for the purpose ofthe following example, no kitting is used.

-   1. Order and Physical Install Process    -   a. Once an order is generated in the iControl system, an account        is created and an install ticket is created and sent        electronically to the security system provider for assignment to        an installer.    -   b. The assigned installer picks up his/her ticket(s) and fills        his/her truck with individual sensors, cameras, iHubs, Simon        XTs, etc. Optionally, the installer can also stock homeplug        adapters for problematic installations.    -   c. The installer arrives at the address on the ticket, and        analyzes the house and talks with the homeowner to determine        sensor locations. At this point assume the homeowner requests        three (3) cameras, five (5) door/window sensors, one (1) glass        break detector, one (1) smoke detector, and one (1) keyfob.    -   d. Installer mounts SimonXT in the kitchen or other location in        the home. The installer routes a phone line to Simon XT if        available. GPRS and Phone numbers are pre-programmed in SimonXT        to point to the provider CMS.    -   e. Installer places gateway in home in the vicinity of a router        and cable modem, and installs an ethernet line from gateway to        the router, and plugs gateway into an electrical outlet.-   2. Associate and Enroll gateway into SimonXT    -   a. Installer uses either his/her own laptop plugged into router,        or homeowners computer to go to the integrated security system        web interface and log in with an installer ID/pass.    -   b. Installer enters ticket number into admin interface, and        clicks ‘New Install’ button. Screen prompts installer to add        devices.    -   c. Installer types in ID of gateway, and it is associated with        the user's account.    -   d. Installer clicks ‘Add Device’ and adds the cameras to the        user's account (by typing in the camera ID/Serial #).    -   e. Installer clicks ‘Add SimonXT’. Instructions prompt installer        to put Simon XT into install mode, and add gateway as a wireless        keypad.    -   f. Installer goes to Simon XT and enters the installer code into        the Simon XT. Learns ‘gateway’ into the panel as a wireless        keypad as group 1 type sensor.    -   g. Installer returns to Web portal, and clicks the ‘Finished        Adding SimonXT’ button.    -   h. Gateway now is alerted to all subsequent installs over the        security system RF.-   3. Enroll Sensors into SimonXT via iControl    -   a. Installer clicks ‘Add Simon XT Sensors’—Displays instructions        for adding sensors to Simon XT.    -   b. Installer goes to Simon XT and uses Simon XT install process        to add each sensor, assigning zone, name, group. These        assignments are recorded for later use.    -   c. The gateway automatically detects each sensor addition and        adds the new sensor to the integrated security system.    -   d. Installer exits install mode on the Simon XT, and returns to        the Web portal.    -   e. Installer clicks ‘Done Adding Devices’.    -   f. Installer enters zone/sensor naming from recorded notes into        integrated security system to associate sensors to friendly        names.    -   g. All sensor information for the account is pushed to the        iConnect server, and is available to propagate to CMS automation        software through the CMS API.-   4. Place and Tests Sensors in Home    -   a. Installer physically mounts each sensor in its desired        location.    -   b. Installer physically mounts Wifi cameras in their location        and plugs into AC power. Optional fishing of low voltage wire        through wall to remove dangling wires. Camera transformer is        still plugged into outlet but wire is now inside the wall.    -   c. Installer puts SimonXT into Test mode from the keypad.    -   d. Installer manually tests the operation of each sensor,        receiving an audible confirmation from SimonXT.    -   e. Installer exits test mode from the Simon XT keypad.    -   f. Installer returns to web interface and is prompted to        automatically set up cameras. After waiting for completion        cameras are now provisioned and operational.-   5. Installer instructs customer on use of the Simon XT, and shows    customer how to log into the integrated security system web and    mobile portals. Customer creates a username/password at this time.-   6. Customer and Installer observe that all sensors/cameras are    green.-   7. Installer instructs customer how to change Simon XT user code    from the keypad. Customer changes user code and stores in SimonXT.-   8. The first time the customer uses the web portal to Arm/Disarm    system the web interface prompts the customer for the user code,    which is then stored securely on the server. In the event the user    code is changed on the panel the web interface once again prompts    the customer.

The panel of an embodiment can be programmed remotely. The CMS pushesnew programming to SimonXT over a telephone or GPRS link. Optionally,iControl and GE provide a broadband link or coupling to the gateway andthen a link from the gateway to the Simon XT over GE RF.

In addition to the configurations described above, the gateway of anembodiment supports takeover configurations in which it is introduced oradded into a legacy security system. A description of example takeoverconfigurations follow in which the security system (FIG. 2, element 210)is a Dialog system and the WSP (FIG. 2, element 211) is a GE Concordpanel (e.g., equipped with POTS, GE RF, and Superbus 2000 RS485interface (in the case of a Lynx takeover the Simon XT is used)available from General Electric Security. The gateway (FIG. 2, element220) in the takeover configurations is an iHub (e.g., equipped withbuilt-in 802.11b/g router, Ethernet Hub, GSM/GPRS card, RS485 interface,and iControl Honeywell-compatible RF card) available from iControlNetworks, Palo Alto, Calif. While components of particular manufacturersare used in this example, the embodiments are not limited to thesecomponents or to components from these vendors.

The security system can optionally include RF wireless sensors (e.g., GEwireless sensors utilizing the GE Dialog RF technology), IP cameras, aGE-iControl Touchscreen (the touchscreen is assumed to be an optionalcomponent in the configurations described herein, and is thus treatedseparately from the iHub; in systems in which the touchscreen is acomponent of the base security package, the integrated iScreen(available from iControl Networks, Palo Alto, Calif.) can be used tocombine iHub technology with the touchscreen in a single unit), andZ-Wave devices to name a few.

The takeover configurations described below assume takeover by a “new”system of an embodiment of a security system provided by another thirdparty vendor, referred to herein as an “original” or “legacy” system.Generally, the takeover begins with removal of the control panel andkeypad of the legacy system. A GE Concord panel is installed to replacethe control panel of the legacy system along with an iHub with GPRSModem. The legacy system sensors are then connected or wired to theConcord panel, and a GE keypad or touchscreen is installed to replacethe control panel of the legacy system. The iHub includes the iControlRF card, which is compatible with the legacy system. The iHub finds andmanages the wireless sensors of the legacy system, and learns thesensors into the Concord by emulating the corresponding GE sensors. TheiHub effectively acts as a relay for legacy wireless sensors.

Once takeover is complete, the new security system provides ahomogeneous system that removes the compromises inherent in taking overor replacing a legacy system. For example, the new system provides amodern touchscreen that may include additional functionality, newservices, and supports integration of sensors from variousmanufacturers. Furthermore, lower support costs can be realized becausecall centers, installers, etc. are only required to support onearchitecture. Additionally, there is minimal install cost because onlythe panel is required to be replaced as a result of the configurationflexibility offered by the iHub.

The system takeover configurations described below include but are notlimited to a dedicated wireless configuration, a dedicated wirelessconfiguration that includes a touchscreen, and a fished Ethernetconfiguration. Each of these configurations is described in detailbelow.

FIG. 18 is a block diagram of a security system in which the legacypanel is replaced with a GE Concord panel wirelessly coupled to an iHub,under an embodiment. All existing wired and RF sensors remain in place.The iHub is located near the Concord panel, and communicates with thepanel via the 802.11 link, but is not so limited. The iHub managescameras through a built-in 802.11 router. The iHub listens to theexisting RF HW sensors, and relays sensor information to the Concordpanel (emulating the equivalent GE sensor). The wired sensors of thelegacy system are connected to the wired zones on the control panel.

FIG. 19 is a block diagram of a security system in which the legacypanel is replaced with a GE Concord panel wirelessly coupled to an iHub,and a GE-iControl Touchscreen, under an embodiment. All existing wiredand RF sensors remain in place. The iHub is located near the Concordpanel, and communicates with the panel via the 802.11 link, but is notso limited. The iHub manages cameras through a built-in 802.11 router.The iHub listens to the existing RF HW sensors, and relays sensorinformation to the Concord panel (emulating the equivalent GE sensor).The wired sensors of the legacy system are connected to the wired zoneson the control panel.

The GE-iControl Touchscreen can be used with either of an 802.11connection or Ethernet connection with the iHub. Because the takeoverinvolves a GE Concord panel (or Simon XT), the touchscreen is always anoption. No extra wiring is required for the touchscreen as it can usethe 4-wire set from the replaced keypad of the legacy system. Thisprovides power, battery backup (through Concord), and data link (RS485Superbus 2000) between Concord and touchscreen. The touchscreen receivesits broadband connectivity through the dedicated 802.11 link to theiHub.

FIG. 20 is a block diagram of a security system in which the legacypanel is replaced with a GE Concord panel connected to an iHub via anEthernet coupling, under an embodiment. All existing wired and RFsensors remain in place. The iHub is located near the Concord panel, andwired to the panel using a 4-wire SUperbus 2000 (RS485) interface, butis not so limited. The iHub manages cameras through a built-in 802.11router. The iHub listens to the existing RF HW sensors, and relayssensor information to the Concord panel (emulating the equivalent GEsensor). The wired sensors of the legacy system are connected to thewired zones on the control panel.

The takeover installation process is similar to the installation processdescribed above, except the control panel of the legacy system isreplaced; therefore, only the differences with the installationdescribed above are provided here. The takeover approach of anembodiment uses the existing RS485 control interfaces that GE Securityand iControl support with the iHub, touchscreen, and Concord panel. Withthese interfaces, the iHub is capable of automatically enrolling sensorsin the panel. The exception is the leverage of an iControl RF cardcompatible with legacy systems to ‘takeover’ existing RF sensors. Adescription of the takeover installation process follows.

During the installation process, the iHub uses an RF Takeover Card toautomatically extract all sensor IDs, zones, and names from the legacypanel. The installer removes connections at the legacy panel fromhardwired wired sensors and labels each with the zone. The installerpulls the legacy panel and replaces it with the GE Concord panel. Theinstaller also pulls the existing legacy keypad and replaces it witheither a GE keypad or a GE-iControl touchscreen. The installer connectslegacy hardwired sensors to appropriate wired zone (from labels) on theConcord. The installer connects the iHub to the local network andconnects the iHub RS485 interface to the Concord panel. The iHubautomatically ‘enrolls’ legacy RF sensors into the Concord panel as GEsensors (maps IDs), and pushes or otherwise propagates other informationgathered from HW panel (zone, name, group). The installer performs atest of all sensors back to CMS. In operation, the iHub relays legacysensor data to the Concord panel, emulating equivalent GE sensorbehavior and protocols.

The areas of the installation process particular to the legacy takeoverinclude how the iHub extracts sensor info from the legacy panel and howthe iHub automatically enrolls legacy RF sensors and populates Concordwith wired zone information. Each of these areas is described below.

In having the iHub extract sensor information from the legacy panel, theinstaller ‘enrolls’ iHub into the legacy panel as a wireless keypad (useinstall code and house ID-available from panel). The iHub legacy RFTakeover Card is a compatible legacy RF transceiver. The installer usesthe web portal to place iHub into ‘Takeover Mode’, and the web portalthe automatically instructs the iHub to begin extraction. The iHubqueries the panel over the RF link (to get all zone information for allsensors, wired and RF). The iHub then stores the legacy sensorinformation received during the queries on the iConnect server.

The iHub also automatically enrolls legacy RF sensors and populatesConcord with wired zone information. In so doing, the installer selects‘Enroll legacy Sensors into Concord’ (next step in ‘Takeover’ process onweb portal). The iHub automatically queries the iConnect server, anddownloads legacy sensor information previously extracted. The downloadedinformation includes an ID mapping from legacy ID to ‘spoofed’ GE ID.This mapping is stored on the server as part of the sensor information(e.g., the iConnect server knows that the sensor is a legacy sensoracting in GE mode). The iHub instructs Concord to go into install mode,and sends appropriate Superbus 2000 commands for sensor learning to thepanel. For each sensor, the ‘spoofed’ GE ID is loaded, and zone, name,and group are set based on information extracted from legacy panel. Uponcompletion, the iHub notifies the server, and the web portal is updatedto reflect next phase of Takeover (e.g., ‘Test Sensors’).

Sensors are tested in the same manner as described above. When a HWsensor is triggered, the signal is captured by the iHub legacy RFTakeover Card, translated to the equivalent GE RF sensor signal, andpushed to the panel as a sensor event on the SuperBus 2000 wires.

In support of remote programming of the panel, CMS pushes newprogramming to Concord over a phone line, or to the iConnect CMS/AlarmServer API, which in turn pushes the programming to the iHub. The iHubuses the Concord Superbus 2000 RS485 link to push the programming to theConcord panel.

FIG. 21 is a flow diagram for automatic takeover 2100 of a securitysystem, under an embodiment. Automatic takeover includes establishing2102 a wireless coupling between a takeover component running under aprocessor and a first controller of a security system installed at afirst location. The security system includes some number of securitysystem components coupled to the first controller. The automatictakeover includes automatically extracting 2104 security data of thesecurity system from the first controller via the takeover component.The automatic takeover includes automatically transferring 2106 thesecurity data to a second controller and controlling loading of thesecurity data into the second controller. The second controller iscoupled to the security system components and replaces the firstcontroller.

FIG. 22 is a flow diagram for automatic takeover 2200 of a securitysystem, under an alternative embodiment. Automatic takeover includesautomatically forming 2202 a security network at a first location byestablishing a wireless coupling between a security system and agateway. The gateway of an embodiment includes a takeover component. Thesecurity system of an embodiment includes security system components.The automatic takeover includes automatically extracting 2204 securitydata of the security system from a first controller of the securitysystem. The automatic takeover includes automatically transferring 2206the security data to a second controller. The second controller of anembodiment is coupled to the security system components and replaces thefirst controller.

Components of the gateway of the integrated security system describedherein control discovery, installation and configuration of both wiredand wireless IP devices (e.g., cameras, etc.) coupled or connected tothe system, as described herein with reference to FIGS. 1-4, as well asmanagement of video routing using a video routing module or engine. Thevideo routing engine initiates communication paths for the transfer ofvideo from a streaming source device to a requesting client device, anddelivers seamless video streams to the user via the communication pathsusing one or more of UPnP port-forwarding, relay server routing andSTUN/TURN peer-to-peer routing, each of which is described below.

By way of reference, conventional video cameras have the ability tostream digital video in a variety of formats and over a variety ofnetworks. Internet protocol (IP) video cameras, which include videocameras using an IP transport network (e.g., Ethernet, WiFi (IEEE 802.11standards), etc.) are prevalent and increasingly being utilized in homemonitoring and security system applications. With the proliferation ofthe internet, Ethernet and WiFi local area networks (LANs) and advancedwide area networks (WANs) that offer high bandwidth, low latencyconnections (broadband), as well as more advanced wireless WAN datanetworks (e.g. GPRS or CDMA 1×RTT), there increasingly exists thenetworking capability to extend traditional security systems to offerIP-based video. However, a fundamental reason for such IP video in asecurity system is to enable a user or security provider to monitor liveor otherwise streamed video from outside the host premises (and theassociated LAN).

The conventional solution to this problem has involved a technique knownas ‘port fowarding’, whereby a ‘port’ on the LAN's router/firewall isassigned to the specific LAN IP address for an IP camera, or a proxy tothat camera. Once a port has been ‘forwarded’ in this manner, a computerexternal to the LAN can address the LAN's router directly, and requestaccess to that port. This access request is then forwarded by the routerdirectly to the IP address specified, the IP camera or proxy. In thisway an external device can directly access an IP camera within the LANand view or control the streamed video.

The issues with this conventional approach include the following: portforwarding is highly technical and most users do not know how/why to doit; automatic port forwarding is difficult and problematic usingemerging standards like UPnP; the camera IP address is often reset inresponse to a power outage/router reboot event; there are many differentrouters with different ways/capabilities for port forwarding. In short,although port forwarding can work, it is frequently less than adequateto support a broadly deployed security solution utilizing IP cameras.

Another approach to accessing streaming video externally to a LANutilizes peer-to-peer networking technology. So-called peer-to-peernetworks, which includes networks in which a device or client isconnected directly to another device or client, typically over a WideArea Network (WAN) and without a persistent server connection, areincreasingly common. In addition to being used for the sharing of filesbetween computers (e.g., Napster and KaZaa), peer-to-peer networks havealso been more recently utilized to facilitate direct audio and mediastreaming in applications such as Skype. In these cases, thepeer-to-peer communications have been utilized to enable telephony-stylevoice communications and video conferencing between two computers, eachenabled with an IP-based microphone, speaker, and video camera. Afundamental reason for adopting such peer-to-peer technology is theability to transparently ‘punch through’ LAN firewalls to enableexternal access to the streaming voice and video content, and to do soin a way that scales to tens of millions of users without creating anuntenable server load.

A limitation of the conventional peer-to-peer video transport lies inthe personal computer (PC)-centric nature of the solution. Each of theconventional solutions uses a highly capable PC connected to the videocamera, with the PC providing the advanced software functionalityrequired to initiate and manage the peer-to-peer connection with theremote client. A typical security or remote home monitoring systemrequires multiple cameras, each with its own unique IP address, and onlya limited amount of processing capability in each camera such that theconventional PC-centric approach cannot easily solve the need. Insteadof a typical PC-centric architecture with three components (a “3-way IPVideo System”) that include a computer device with video camera, amediating server, and a PC client with video display capability, theconventional security system adds a plurality of fourth components thatare standalone IP video cameras (requiring a “4-way IP Video System”),another less-than-ideal solution.

In accordance with the embodiments described herein, IP cameramanagement systems and methods are provided that enable a consumer orsecurity provider to easily and automatically configure and manage IPcameras located at a customer premise. Using this system IP cameramanagement may be extended to remote control and monitoring from outsidethe firewall and router of the customer premise.

With reference to FIGS. 5 and 6, the system includes a gateway 253having a video routing component so that the gateway 253 can manage andcontrol, or assist in management and control, or video routing. Thesystem also includes one or more cameras (e.g., WiFi IP camera 254,Ethernet IP camera 255, etc.) that communicate over the LAN 250 using anIP format, as well as a connection management server 210 located outsidethe premise firewall 252 and connected to the gateway 253 by a Wide AreaNetwork (WAN) 200. The system further includes one or more devices 220,230, 240 located outside the premise and behind other firewalls 221,231, 241 and connected to the WAN 200. The other devices 220, 230, 240are configured to access video or audio content from the IP cameraswithin the premise, as described above.

Alternatively, with reference to FIGS. 9 and 10, the system includes atouchscreen 902 or 1002 having a video routing component so that thetouchscreen 902 or 1002 can manage and control, or assist in managementand control, or video routing. The system also includes one or morecameras (e.g., WiFi IP camera 254, Ethernet IP camera 255, etc.) thatcommunicate over the LAN 250 using an IP format, as well as a connectionmanagement server 210 located outside the premise firewall 252 andconnected to the gateway 253 by a Wide Area Network (WAN) 200. Thesystem further includes one or more devices 220, 230, 240 locatedoutside the premise and behind other firewalls 221, 231, 241 andconnected to the WAN 200. The other devices 220, 230, 240 are configuredto access video or audio content from the IP cameras within the premise,as described above.

FIG. 23 is a general flow diagram for IP video control, under anembodiment. The IP video control interfaces, manages, and providesWAN-based remote access to a plurality of IP cameras in conjunction witha home security or remote home monitoring system. The IP video controlallows for monitoring and controlling of IP video cameras from alocation remote to the customer premise, outside the customer premisefirewall, and protected by another firewall. Operations begin when thesystem is powered on 2310, involving at a minimum the power-on of thegateway, as well as the power-on of at least one IP camera coupled orconnected to the premise LAN. The gateway searches 2311 for available IPcameras and associated IP addresses. The gateway selects 2312 from oneor more possible approaches to create connections between the IP cameraand a device external to the firewall. Once an appropriate connectionpath is selected, the gateway begins operation 2313, and awaits 2320 arequest for a stream from one of the plurality of IP video camerasavailable on the LAN. When a stream request is present the serverretrieves 2321 the requestor's WAN IP address/port.

When a server relay is present 2330, the IP camera is instructed 2331 tostream to the server, and the connection is managed 2332 through theserver. In response to the stream terminating 2351, operations return togateway operation 2313, and waits to receive another request 2320 for astream from one of the plurality of IP video cameras available on theLAN.

When a server relay is not present 2330, the requestor's WAN IPaddress/port is provided 2333 to the gateway or gateway relay. When agateway relay is present 2340, the IP camera is instructed 2341 tostream to the gateway, and the gateway relays 2342 the connection to therequestor. In response to the stream terminating 2351, operations returnto gateway operation 2313, and waits to receive another request 2320 fora stream from one of the plurality of IP video cameras available on theLAN. When a gateway relay is not present 2340, the IP camera isinstructed 2343 to stream to an address, and a handoff 2344 is maderesulting in direct communication between the camera and the requestor.In response to the stream terminating 2351, operations return to gatewayoperation 2313, and waits to receive another request 2320 from one ofthe plurality of IP video cameras available on the LAN.

The integrated security system of an embodiment supports numerous videostream formats or types of video streams. Supported video streamsinclude, but are not limited to, Motion Picture Experts Group (MPEG)-4(MPEG-4)/Real-Time Streaming Protocol (RTSP), MPEG-4 over HypertextTransfer Protocol (HTTP), and Motion Joint Photographic Experts Group(JPEG) (MJPEG).

The integrated security system of an embodiment supports the MPEG-4/RTSPvideo streaming method (supported by video servers and clients) whichuses RTSP for the control channel and Real-time Transport Protocol (RTP)for the data channel. Here the RTSP channel is over Transmission ControlProtocol (TCP) while the data channel uses User Datagram Protocol (UDP).This method is widely supported by both streaming sources (e.g.,cameras) and stream clients (e.g., remote client devices, AppleQuicktime, VideoLAN, IPTV mobile phones, etc).

Encryption can be added to the two channels under MPEG-4/RTSP. Forexample, the RTSP control channel can be encrypted using SSL/TLS. Thedata channel can also be encrypted.

If the camera or video stream source inside the home does not supportencryption for either RTSP or RTP channels, the gateway located on theLAN can facilitate the encrypted RTSP method by maintaining separate TCPsessions with the video stream source device and with the encrypted RTSPclient outside the LAN, and relay all communication between the twosessions. In this situation, any communication between the gateway andthe video stream source that is not encrypted could be encrypted by thegateway before being relayed to the RTSP client outside the LAN. In manycases the gateway is an access point for the encrypted and private Wifinetwork on which the video stream source device is located. This meansthat communication between the gateway and the video stream sourcedevice is encrypted at the network level, and communication between thegateway and the RTSP client is encrypted at the transport level. In thisfashion the gateway can compensate for a device that does not supportencrypted RTSP.

The integrated security system of an embodiment also supports reverseRTSP. Reverse RTSP includes taking a TCP-based protocol like RTSP, andreversing the roles of client and server (references to “server” includethe iControl server, also referred to as the iConnect server) when itcomes to TCP session establishment. For example, in standard RTSP theRTSP client is the one that establishes the TCP connection with thestream source server (the server listens on a port for incomingconnections). In Reverse RTSP, the RTSP client listens on a port forincoming connections from the stream source server. Once the TCPconnection is established, the RTSP client begins sending commands tothe server over the TCP connection just as it would in standard RTSP.

When using Reverse RTSP, the video stream source is generally on a LAN,protected by a firewall. Having a device on the LAN initiate theconnection to the RTSP client outside the firewall enables easy networktraversal.

If the camera or video stream source inside the LAN does not supportReverse RTSP, then the gateway facilitates the Reverse RTSP method byinitiating separate TCP sessions with the video stream source device andwith the Reverse RTSP client outside the LAN, and then relays allcommunication between the two sessions. In this fashion the gatewaycompensates for a stream source device that does not support ReverseRTSP.

As described in the encryption description above, the gateway canfurther compensate for missing functionalities on the device such asencryption. If the device does not support encryption for either RTSP orRTP channels, the gateway can communicate with the device using theseun-encrypted streams, and then encrypt the streams before relaying themout of the LAN to the RTSP Reverse client.

Servers of the integrated security system can compensate for RTSPclients that do not support Reverse RTSP. In this situation, the serveraccepts TCP connections from both the RTSP client and the Reverse RTSPvideo stream source (which could be a gateway acting on behalf of astream source device that does not support Reverse RTSP). The serverthen relays the control and video streams from the Reverse RTSP videostream source to the RTSP client. The server can further compensate forthe encryption capabilities of the RTSP client; if the RTSP client doesnot support encryption then the server can provide an unencrypted streamto the RTSP client even though an encrypted stream was received from theReverse RTSP streaming video source.

The integrated security system of an embodiment also supports SimpleTraversal of User Datagram Protocol (UDP) through Network AddressTranslators (NAT) (STUN)/Traversal Using Relay NAT (TURN) peer-to-peerrouting. STUN and Turn are techniques for using a server to helpestablish a peer-to-peer UDP data stream (it does not apply to TCPstreams). The bandwidth consumed by the data channel of a video streamis usually many thousands of times larger than that used by the controlchannel. Consequently, when a peer-to-peer connection for both the RTSPand RTP channels is not possible, there is still a great incentive touse STUN/TURN techniques in order to achieve a peer-to-peer connectionfor the RTP data channel.

Here, a method referred to herein as RTSP with STUN/TURN is used by theintegrated security system. The RTSP with STUN/TURN is a method in whichthe video streaming device is instructed over the control channel tostream its UDP data channel to a different network address than that ofthe other end of the control TCP connection (usually the UDP data issimply streamed to the IP address of the RTSP client). The result isthat the RTSP or Reverse RTSP TCP channel can be relayed using thegateway and/or the server, while the RTP UDP data channel can flowdirectly from the video stream source device to the video stream client.

If a video stream source device does not support RTSP with STUN/TURN,the gateway can compensate for the device by relaying the RTSP controlchannel via the server to the RTSP client, and receiving the RTP datachannel and then forwarding it directly to the RTSP with STUN/TURNenabled client. Encryption can also be added here by the gateway.

The integrated security system of an embodiment supports MPEG-4 overHTTP. MPEG-4 over HTTP is similar to MPEG-4 over RTSP except that boththe RTSP control channel and the RTP data channel are passed over anHTTP TCP session. Here a single TCP session can be used, splitting itinto multiple channels using common HTTP techniques like chunkedtransfer encoding.

The MPEG-4 over HTTP is generally supported by many video stream clientsand server devices, and encryption can easily be added to it usingSSL/TLS. Because it uses TCP for both channels, STUN/TURN techniques maynot apply in the event that a direct peer-to-peer TCP session betweenclient and server cannot be established.

As described above, encryption can be provided using SSL/TLS taking theform of HTTPS. And as with MPEG-4 over RTSP, a gateway can compensatefor a stream source device that does not support encryption by relayingthe TCP streams and encrypting the TCP stream between the gateway andthe stream client. In many cases the gateway is an access point for theencrypted and private Wifi network on which the video stream sourcedevice is located. This means that communication between the gateway andthe video stream source device is encrypted at the network level, andcommunication between the gateway and the video stream client isencrypted at the transport level. In this fashion the gateway cancompensate for a device that does not support HTTPS.

As with Reverse RTSP, the integrated security system of an embodimentsupports Reverse HTTP. Reverse HTTP includes taking a TCP-based protocollike HTTP, and reversing the roles of client and server when it comes toTCP session establishment. For example, in conventional HTTP the HTTPclient is the one that establishes the TCP connection with the server(the server listens on a port for incoming connections). In ReverseHTTP, the HTTP client listens on a port for incoming connections fromthe server. Once the TCP connection is established, the HTTP clientbegins sending commands to the server over the TCP connection just as itwould in standard HTTP.

When using Reverse HTTP, the video stream source is generally on a LAN,protected by a firewall. Having a device on the LAN initiate theconnection to the HTTP client outside the firewall enables easy networktraversal.

If the camera or video stream source inside the LAN does not supportReverse HTTP, then the gateway can facilitate the Reverse HTTP method byinitiating separate TCP sessions with the video stream source device andwith the Reverse HTTP client outside the LAN, and then relay allcommunication between the two sessions. In this fashion the gateway cancompensate for a stream source device that does not support ReverseHTTP.

As described in the encryption description above, the gateway canfurther compensate for missing functionalities on the device such asencryption. If the device does not support encrypted HTTP (e.g., HTTPS),then the gateway can communicate with the device using HTTP, and thenencrypt the TCP stream(s) before relaying out of the LAN to the ReverseHTTP client.

The servers of an embodiment can compensate for HTTP clients that do notsupport Reverse HTTP. In this situation, the server accepts TCPconnections from both the HTTP client and the Reverse HTTP video streamsource (which could be a gateway acting on behalf of a stream sourcedevice that does not support Reverse HTTP). The server then relays theTCP streams from the Reverse HTTP video stream source to the HTTPclient. The server can further compensate for the encryptioncapabilities of the HTTP client; if the HTTP client does not supportencryption then the server can provide an unencrypted stream to the HTTPclient even though an encrypted stream was received from the ReverseHTTP streaming video source.

The integrated security system of an embodiment supports MJPEG asdescribed above. MJPEG is a streaming technique in which a series of JPGimages are sent as the result of an HTTP request. Because MJPEG streamsare transmitted over HTTP, HTTPS can be employed for encryption and mostMJPEG clients support the resulting encrypted stream. And as with MPEG-4over HTTP, a gateway can compensate for a stream source device that doesnot support encryption by relaying the TCP streams and encrypting theTCP stream between the gateway and the stream client. In many cases thegateway is an access point for the encrypted and private Wifi network onwhich the video stream source device is located. This means thatcommunication between the gateway and the video stream source device isencrypted at the network level, and communication between the gatewayand the video stream client is encrypted at the transport level. In thisfashion the gateway can compensate for a device that does not supportHTTPS.

The integrated system of an embodiment supports Reverse HTTP. ReverseHTTP includes taking a TCP-based protocol like HTTP, and reversal of theroles of client and server when it comes to TCP session establishmentcan be employed for MJPEG streams. For example, in standard HTTP theHTTP client is the one who establishes the TCP connection with theserver (the server listens on a port for incoming connections). InReverse HTTP, the HTTP client listens on a port for incoming connectionsfrom the server. Once the TCP connection is established, the HTTP clientbegins sending commands to the server over the TCP connection just as itwould in standard HTTP.

When using Reverse HTTP, the video stream source is generally on a LAN,protected by a firewall. Having a device on the LAN initiate theconnection to the HTTP client outside the firewall enables networktraversal.

If the camera or video stream source inside the LAN does not supportReverse HTTP, then the gateway can facilitate the Reverse HTTP method byinitiating separate TCP sessions with the video stream source device andwith the Reverse HTTP client outside the LAN, and then relay allcommunication between the two sessions. In this fashion the gateway cancompensate for a stream source device that does not support ReverseHTTP.

As described in the encryption description above, the gateway canfurther compensate for missing functionalities on the device such asencryption. If the device does not support encrypted HTTP (e.g., HTTPS),then the gateway can communicate with the device using HTTP, and thenencrypt the TCP stream(s) before relaying out of the LAN to the ReverseHTTP client.

The servers can compensate for HTTP clients that do not support ReverseHTTP. In this situation, the server accepts TCP connections from boththe HTTP client and the Reverse HTTP video stream source (which could bea gateway acting on behalf of a stream source device that does notsupport Reverse HTTP). The server then relays the TCP streams from theReverse HTTP video stream source to the HTTP client. The server canfurther compensate for the encryption capabilities of the HTTP client;if the HTTP client does not support encryption then the server canprovide an unencrypted stream to the HTTP client even though anencrypted stream was received from the Reverse HTTP streaming videosource.

The integrated security system of an embodiment considers numerousparameters in determining or selecting one of the streaming formatsdescribed above for use in transferring video streams. The parametersconsidered in selecting a streaming format include, but are not limitedto, security requirements, client capabilities, device capabilities, andnetwork/system capabilities.

The security requirements for a video stream are considered indetermining an applicable streaming format in an embodiment. Securityrequirements fall into two categories, authentication and privacy, eachof which is described below.

Authentication as a security requirement means that stream clients mustpresent credentials in order to obtain a stream. Furthermore, thispresentation of credentials should be done in a way that is secure fromnetwork snooping and replays. An example of secure authentication isBasic Authentication over HTTPS. Here a username and password arepresented over an encrypted HTTPS channel so snooping and replays areprevented. Basic Authentication alone, however, is generally notsufficient for secure authentication.

Because not all streaming clients support SSL/TLS, authenticationmethods that do not require it are desirable. Such methods includeDigest Authentication and one-time requests. A one-time request is arequest that can only be made by a client one time, and the serverprevents a reuse of the same request. One-time requests are used tocontrol access to a stream source device by stream clients that do notsupport SSL/TLS. An example here is providing video access to a mobilephone. Typical mobile phone MPEG-4 viewers do not support encryption. Inthis case, one of the MPEG-4 over RTSP methods described above can beemployed to get the video stream relayed to an server. The server canthen provide the mobile phone with a one-time request Universal ResourceLocator (URL) for the relayed video stream source (via a WirelessApplication Protocol (WAP) page). Once the stream ends, the mobile phonewould need to obtain another one-time request URL from the server (viaWAP, for example) in order to view the stream again.

Privacy as a security requirement means that the contents of the videostream must be encrypted. This is a requirement that may be impossibleto satisfy on clients that do not support video stream encryption, forexample many mobile phones. If a client supports encryption for somevideo stream format(s), then the “best” of those formats should beselected. Here “best” is determined by the stream type priorityalgorithm.

The client capabilities are considered in determining an applicablestreaming format in an embodiment. In considering client capabilities,the selection depends upon the supported video stream formats thatinclude encryption, and the supported video stream formats that do notsupport encryption.

The device capabilities are considered in determining an applicablestreaming format in an embodiment. In considering device capabilities,the selection depends upon the supported video stream formats thatinclude encryption, the supported video stream formats that do notsupport encryption, and whether the device is on an encrypted privateWifi network managed by the gateway (in which case encryption at thenetwork level is not required).

The network/system capabilities are considered in determining anapplicable streaming format in an embodiment. In consideringnetwork/system capabilities, the selection depends upon characteristicsof the network or system across which the stream must travel. Thecharacteristics considered include, for example, the following: whetherthere is a gateway and/or server on the network to facilitate some ofthe fancier video streaming types or security requirements; whether theclient is on the same LAN as the gateway, meaning that network firewalltraversal is not needed.

Streaming methods with the highest priority are peer-to-peer becausethey scale best with server resources. Universal Plug and Play (UPnP)can be used by the gateway to open ports on the video stream device'sLAN router and direct traffic through those ports to the video streamdevice. This allows a video stream client to talk directly with thevideo stream device or talk directly with the gateway which can in turnfacilitate communication with the video stream device.

Another factor in determining the best video stream format to use is thesuccess of STUN and TURN methods for establishing direct peer-to-peerUDP communication between the stream source device and the streamclient. Again, the gateway and the server can help with the setup ofthis communication.

Client bandwidth availability and processing power are other factors indetermining the best streaming methods. For example, due to itsbandwidth overhead an encrypted MJPEG stream should not be consideredfor most mobile phone data networks.

Device bandwidth availability can also be considered in choosing thebest video stream format. For example, consideration can be given towhether the upstream bandwidth capabilities of the typical residentialDSL support two or more simultaneous MJPEG streams.

Components of the integrated security system of an embodiment, whileconsidering various parameters in selecting a video streaming format totransfer video streams from streaming source devices and requestingclient devices, prioritize streaming formats according to theseparameters. The parameters considered in selecting a streaming formatinclude, as described above, security requirements, client capabilities,device capabilities, and network/system capabilities. Components of theintegrated security system of an embodiment select a video streamingformat according to the following priority, but alternative embodimentscan use other priorities.

The selected format is UPnP or peer-to-peer MPEG-4 over RTSP withencryption when both requesting client device and streaming sourcedevice support this format.

The selected format is UPnP or peer-to-peer MPEG-4 over RTSP withauthentication when the requesting client device does not supportencryption or UPnP or peer-to-peer MPEG-4 over RTSP with encryption.

The selected format is UPnP (peer-to-peer) MPEG-4 over HTTPS when bothrequesting client device and streaming source device support thisformat.

The selected format is UPnP (peer-to-peer) MPEG-4 over HTTP when therequesting client device does not support encryption or UPnP(peer-to-peer) MPEG-4 over HTTPS.

The selected format is UPnP (peer-to-peer) MPEG-4 over RTSP facilitatedby gateway or touchscreen (including or incorporating gatewaycomponents) (to provide encryption), when the requesting client devicesupports encrypted RTSP and the streaming source device supports MPEG-4over RTSP.

The selected format is UPnP (peer-to-peer) MPEG-4 over HTTPS facilitatedby gateway or touchscreen (including or incorporating gatewaycomponents) (to provide encryption) when the requesting client devicesupports MPEG-4 over HTTPS and the streaming source device supportsMPEG-4 over HTTP.

The selected format is UPnP (peer-to-peer) MJPEG over HTTPS when thenetworks and devices can handle the bandwidth and both requesting clientdevice and streaming source device support MJPEG over HTTPS.

The selected format is Reverse RTSP with STUN/TURN facilitated by theserver when the streaming source device initiates SSL/TLS TCP to server,the streaming source device supports Reverse RTSP over SSL/TLS withSTUN/TURN, and the requesting client device supports RTSP withSTUN/TURN.

The selected format is Reverse RTSP with STUN/TURN facilitated by serverand gateway or touchscreen (including or incorporating gatewaycomponents) when the gateway initiates SSL/TLS TCP to the server and tothe streaming source device, the streaming source device supports RTSP,and the requesting client device supports RTSP with STUN/TURN.

The selected format is Reverse MPEG over RTSP/HTTP facilitated by theserver when the streaming source device initiates SSL/TLS TCP to server,the streaming source device supports Reverse RTSP or HTTP over SSL/TLS,and the requesting client device supports MPEG over RTSP/HTTP.

The selected format is Reverse MPEG over RTSP/HTTP facilitated by serverand gateway or touchscreen (including or incorporating gatewaycomponents) when the gateway initiates SSL/TLS TCP to server and tostreaming source device, the streaming source device supports MPEG overRTSP or HTTP, and the requesting client device supports MPEG overRTSP/HTTP.

The selected format is UPnP (peer-to-peer) MJPEG over HTTP when thenetworks and devices can handle the bandwidth and when the requestingclient device does not support encryption and does not support MPEG-4.

The selected format is Reverse MJPEG over HTTPS facilitated by theserver when the streaming source device initiates SSL/TLS TCP to server,the streaming source device supports Reverse MJPEG over SSL/TLS, and therequesting client device supports MJPEG.

The selected format is Reverse MJPEG over HTTPS facilitated by serverand gateway or touchscreen (including or incorporating gatewaycomponents) when the gateway initiates SSL/TLS TCP to the server and tothe streaming source device, the streaming source device supports MJPEG,and the requesting client device supports MJPEG.

FIG. 24 is a block diagram showing camera tunneling, under anembodiment.

Additional detailed description of camera tunnel implementation detailsfollow.

An embodiment uses XMPP for communication with a remote video camera asa lightweight (bandwidth) method for maintaining real-time communicationwith the remote camera. More specifically, the remote camera is locatedon another NAT (e.g., NAT traversal).

An embodiment comprises a method for including a remotely located camerain a home automation system. For example, using XMPP via cloud XMPPserver to couple or connect camera to home automation system. This canbe used with in-car cameras, cell phone cameras, and re-locatablecameras (e.g., dropped in the office, the hotel room, the neighbor'shouse, etc.).

Components of an embodiment are distributed so that any one can beoffline while system continues to function (e.g., panel can be downwhile camera still up, motion detection from camera, video clip uploadetc. continue to work.

Embodiments extend the PSIA in one or more of the following areas: wifiroaming configuration; video relay commands; wifi connectivity test;media tunnel for live video streaming in the context of a securitysystem; motion notification mechanism and configuration (motionheartbeat) (e.g., helps with scalable server); XMPP for lightweightcommunication (helps with scalable server, reduced bandwidth, formaintaining persistent connection with a gateway); ping request sentover XMPP as health check mechanism; shared secret authenticationbootstrapping process; asynchronous error status delivery by the camerafor commands invoked by the gateway if the camera is responsible fordelivering errors to the gateway in an asynchronous fashion (e.g.,gateway requests a firmware update or a video clip upload).

Embodiments extend the home automation system to devices located onseparate networks, and make them useable as general-purposecommunication devices. These cameras can be placed in the office,vacation home, neighbor house, software can be put onto a cell phone,into a car, navigation system, etc.

Embodiments use a global device registry for enabling a device/camera tolocate the server and home to which it is assigned.

Embodiments include methods for bootstrapping and re-bootstrapping ofauthentication credentials. The methods include activation key entry byinstaller into the cloud web interface. Activation key generation isbased upon mac address and a shared secret between manufacturer and theservice provider. Embodiments of the system allow activation of a camerawith valid activation key that is not already provisioned in the globalregistry server.

Embodiments include a web-based interface for use in activating,configuring, remote firmware update, and re-configuring of a camera.

Embodiments process or locate local wifi access points and provide theseas options during camera configuring and re-configuring. Embodimentsgenerate and provide recommendations around choosing a best wifi accesspoint based upon characteristics of the network (e.g., signal strength,error rates, interference, etc.). Embodiments include methods fortesting and diagnosing issues with wifi and network access.

Embodiments include cameras able to perform this wifi test using onlyone physical network interface, an approach that enables the camera todynamically change this physical interface from wired to wifi.Embodiments are able to change the network settings (wifi etc) remotelyusing the same process.

Cameras of an embodiment can be configured with multiple networkpreferences with priority order so that the camera can move betweendifferent locations and the camera can automatically find the bestnetwork to join (e.g., can have multiple ssid+bssid+password setsconfigured and prioritized).

Regarding firmware download, embodiments include a mechanism to monitorthe status of the firmware update, provide feedback to the end user andimprove overall quality of the system.

Embodiments use RTSP over SSL to a cloud media relay server to allowlive video NAT traversal to a remote client (e.g., PC, cell phone, etc.)in a secure manner where the camera provides media sessionauthentication credentials to the server. The camera initiates the SSLconnection to the cloud and then acts as a RTSP server over thisconnection.

Embodiments include methods for using NAT traversal for connecting tothe cloud for remote management and live video access allows theintegrated security components to avoid port forwarding on the localrouter(s) and as a result maintain a more secure local network and amore secure camera since no ports are required to be open.

Embodiments enable camera sensors (e.g., motion, audio, heat, etc.) toserve as triggers to other actions in the automation system. The captureof video clips or snapshots from the camera is one such action, but theembodiments are not so limited.

A camera of an embodiment can be used by multiple systems.

A detailed description of flows follows relating to the camera tunnel ofan embodiment.

A detailed description of camera startup and installation follows as itpertains to the camera tunnel of an embodiment.

Activation Key

-   -   a. camera to follow same algorithm as ihub where activation key        is generated from serial based upon a one-way hash on serial and        a per-vendor shared secret.    -   b. Used com.icontrol.util.ops.activation.ActivationKeyUtil class        to validate serialNo <-> activationKey.        Registry Request        [partner]/registry/[device type]/[serial]    -   a. new column in existing registry table for id type; nullable        but the application treats null as “gateway”.    -   b. rest endpoints allow adding with the new optional argument.    -   c. current serial and siteId uniqueness enforcement by        application depends upon device type (for any device type, there        should be uniqueness on serial; for gateway device type, there        should be uniqueness on siteId; for other device types, there        need not be uniqueness on siteId).    -   d. if no activation yet (e.g., no entry) then send dummy        response (random but repeatable reply; may include predictable        “dummy” so that steps below can infer.    -   e. add/update registry server endpoints for adding/updating        entries.        If Camera has No Password        Camera retrieves “Pending Key” via POST to        /<CredentialGatewayURL>/GatewayService/<siteID>/PendingDeviceKey.    -   a. pending key request (to get password) with serial and        activation key.    -   b. server checks for dummy reply; if dummy then responds with        retry backoff response.    -   c. server invokes pass-through API on gateway to get new pending        key.    -   d. if device is found, then gateway performs validation of        serial+activation key, returns error if mismatch.    -   e. if activation key checks out, then gateway checks pending key        status.    -   f. if device currently has a pending key status, then a new        pending password is generated.    -   g. gateway maintains this authorization information in a new set        of variables on the camera device.    -   h. device-authorization/session-key comprises the current        connected password.    -   i. device-authorization/pending-expiry comprises a UTC timestamp        representing the time the current pending password period ends;        any value less than the current time or blank means the device        is not in a pending password state.    -   j. device-authorization/pending-session-key comprises the last        password returned to the camera in a pending request; this is        optional (device may choose to maintain this value in memory).    -   k. session-key and pending-session-key variables tagged with        “encryption” in the device def which causes rest and admin to        hide their value from client.        ConnectInfo Request    -   a. returns xmpp host and port to connect to (comes from config        as it does for gateway connect info).    -   b. returns connectInfo with additional <xmpp> parameter.        Start Portal Add Camera Wizard    -   a. user enters camera serial, activation key.    -   b. addDevice rest endpoint on gateway called    -   c. gateway verifies activation key is correct.    -   d. gateway calls addDevice method on gapp server to add        LWG_SerComm_iCamera_1000 with given serial to site.    -   e. Server detects the camera type and populates registry.    -   f. gateway puts device into pending password state (e.g.,        updates device-auth/pending-expiry point).    -   g. rest endpoints on gateway device for managing device pending        password state.    -   h. start pending password state: POST future UTC value to        device-auth/pending-expiry; device-auth/pending-expiry set to 30        minutes from time device was added.    -   i. stop pending password state: POST −1 to        device-auth/pending-expiry.    -   j. check pending password state: GET device-auth/pending-expiry.    -   k. message returned with “Location” header pointing to relative        URI.    -   l. user told to power on camera (or reboot if already powered        on).    -   m. once camera connects, gateway updates        device-auth/pending-expiry to −1 and device-auth/session-key        with password and device/connection-status to connected    -   n. portal polls for device/connection-status to change to        connected; if does not connect after X seconds, bring up error        page (camera has not connected—continue waiting or start over).    -   o. user asked if wifi should be configured for this camera.    -   p. entry fields for wifi ssid and password.    -   q. portal can pre-populate ssid and password fields with        picklist of any from other cameras on the site.    -   r. get XML of available SSIDs.    -   s. non-wifi option is allowed.    -   t. portal submits options to configure camera (use null values        to specify non-wifi); upon success, message is returned with        “Location” header pointing to relative URI.    -   u. checks configuration progress and extracting “status” and        “subState” fields.    -   v. puts device state into “configuring”; upon error, puts device        state into “configuration failure”.    -   w. performs firmware upgrade if needed, placing device state        into “upgrading”; upon error, puts device state into “upgrade        failure”.    -   x. upon configuration success, puts device state of“ok” and        applies appropriate configuration for camera (e.g., resolutions,        users, etc.).    -   y. if non-blank wifi parameters, automatically perform “wifi        test” method to test wifi without disconnecting Ethernet.    -   z. portal wizard polls device status until changes to “ok” or        “upgrade failure/“configuration failure” in “status” field,        along with applicable, if any, with error code reason, in        “subState” field; upon error, show details to user, provide        options (start over, configure again, reboot, factory reset,        etc)    -   aa. notify user they can move camera to desired location.        Camera Reboots    -   a. gets siteId and server URL from registry.    -   b. makes pending paid key request to server specifying correct        siteId, serial and activation key; gets back pending password.    -   c. makes connectInfo request to get xmpp server.    -   d. connects over xmpp with pending password.        If Camera Reboots Again    -   a. get siteId and server URL from registry.    -   b. already has password (may or may not be pending) so no need        to perform pending paid key request.    -   c. make connectInfo request to get xmpp server.    -   d. connect over xmpp with password.        xmpp Connect with Password    -   a. xmpp user is of the form [serial]@[server]/[siteId]    -   b. session server performs authentication by making passthrough        API request to gateway for given SiteId.    -   c. Session xmpp server authenticates new session using DeviceKey        received in GET request against received xmpp client credential.    -   d. If authentication fails or GET receives non-response, server        returns to camera XMPP connect retry backoff with long backoff.    -   e. gateway device performs password management.    -   f. compares password with current key and pending key (if not        expired); if matches pending, then update        device-auth/session-key to be pending value, and clear out the        device-auth/pending-expiry.    -   g. gateway device updates the device/connection-status point to        reflect that camera is connected.    -   h. gateway device tracks the xmpp session server this camera is        connected to via new point device/proxy-host and updates this        info if changed.    -   i. if deviceConnected returns message, then session server posts        connected event containing xmpp user to queue monitored by all        session servers.    -   j. session servers monitor these events and disconnect/cleanup        sessions they have for same user.    -   k. may use new API endpoint on session server for broadcast        messages.        xmpp Connect with Bad Password    -   a. Upon receiving a new connection request, session server        performs authentication by making passthrough API request to        gateway for given SiteId.    -   b. Session xmpp server authenticates new session using DeviceKey        received in above GET request against received xmpp client        credential.    -   c. If authentication fails or GET receives non-response from        virtual gateway.    -   d. Session server rejects incoming connection (is there a        backoff/retry XMPP response that can be sent here).    -   e. Session server logs event.    -   f. Gateway logs event.        xmpp Disconnect    -   a. session server posts disconnected event to gateway (with        session server name).    -   b. gateway updates the device/connected variable/point to        reflect that camera is disconnected.    -   c. gateway updates the device/connection-status variable/point        to reflect that camera is disconnected.    -   d. gateway clears the device/proxy-host point that contains the        session host to this camera is connected.        LWGW Shutdown    -   a. During LWGW shutdown, gateway can broadcast messages to all        XMPP servers to ensure all active XMPP sessions are gracefully        shutdown.    -   b. gateways use REST client to call URI, which will broadcast to        all XMPP servers.        To Configure Camera During Installation    -   a. applies all appropriate configuration for camera (e.g.,        resolutions, users, etc).    -   b. returns message for configuration applied, wifi test passed,        all settings taken. returns other response code with error code        description upon any failure.        To Reconfigure Wifi SSID and Key    -   a. returns message for wifi credentials set.    -   b. returns other response code with error code description upon        any failure.        API Pass-Through Handling for Gateway Fail-Over Case    -   a. When performing passthrough for LWGW, the API endpoint        handles the LWGW failover case (e.g., when gateway is not        currently running on any session server).    -   b. passthrough functions in the following way: current session        server IP is maintained on the gateway object; server looks up        gateway object to get session IP and then sends passthrough        request to that session server; if that request returns gateway        not found message, server error message, or a network level        error (e.g., cannot route to host, etc.), if the gateway is a        LWGW then server should lookup theprimary/secondary LW Gateway        group for this site; server should then send resume message to        primary, followed by rest request; if that fails, then server        send resume message to secondary followed by rest request    -   c. alternatively, passthrough functions in the following way:        rather than lookup session server IP on gateway object,        passthrough requests should be posted to a passthrough queue        that is monitored by all session servers; the session server        with the Gateway on it should consume the message (and pass it        to the appropriate gateway); the server should monitor for        expiry of these messages, and if the gateway is a LWGW then        server should lookup the primary/secondary LW Gateway group for        this site; server should then send resume message to primary,        followed by rest request; if that fails, then server send resume        message to secondary followed by rest request.

A detailed description follows for additional flows relating to thecamera tunnel of an embodiment.

Motion Detection

-   -   a. camera sends openhome motion event to session server via        xmpp.    -   b. session server posts motion event to gateway via passthrough        API.    -   c. gateway updates the camera motion variable/point to reflect        the event gateway updates the camera motion variable/point to        reflect the event        Capture Snapshot    -   a. gateway posts openhome snapshot command to session server        with camera connected.    -   b. gateway sends command including xmpp user id to xmpp command        Queue monitored by all session servers.    -   c. session server with given xmpp user id consumes command and        sends command to camera (command contains upload URL on gw        webapp).    -   d. gateway starts internal timer to check if a response is        received from camera (e.g., 5 sec wait window).    -   e. if broadcast RabbitMQ not ready, then gateway will use        device/proxy-host value to know which session server to post        command to.    -   f. session server sends command to camera (comprises upload URL        on gw webapp)    -   g. Example XML body:

<MediaUpload> <id>1321896772660</id><snapShotImageType>JPEG</snapShotImageType><gateway_url>[gatewaysyncUrl]/gw/GatewayService/SPutJpg/s/[siteId]/[deviceIndex]/[varValue]/[varIndex]/[who]/[ts]/[HMM]/[passCheck]/</<failure_url>[gatewaysyncUrl]/gw/GatewayService/SPutJpgError/s/[siteId]/[deviceIndex]/[varValue]/[varIndex]/[who]/[ts]/[HMM]/[passCheck]/</</MediaUpload>

-   -   h. session server receives response to sendRequestEvent from        camera and posts response to gateway.    -   i. camera uploads to upload URL on gw webapp.    -   j. passCheck can be verified on server (based upon gateway        secret); alternatively, the OpenHome spec calls for Digest Auth        here.    -   k. endpoint responds with message digest password if the URI is        expected, otherwise returns non-response.    -   l. gw webapp stores snapshot, logs history event.    -   m. event is posted to gateway for deltas.        Capture Clip    -   a. gateway posts openhome video clip capture command to session        server with camera connected.    -   b. gateway sends command including xmpp user id to xmpp command        Queue monitored by all session servers.    -   c. session server with given xmpp user id consumes command and        sends command to camera (command comprises upload URL on gw        webapp).    -   d. gateway starts internal timer to check if a response is        received from camera (e.g., 5 sec wait window).    -   e. session server sends command to camera (comprises upload URL        on gw webapp).    -   f. Example URI from session server to camera:        /openhome/streaming/channels/1/video/upload    -   g. Example XML body:

<MediaUpload> <id>1321898092270</id><videoClipFormatType>MP4</videoClipFormatType><gateway_url>[gatewaysyncUrl]/gw/GatewayService/SPutMpeg/s/[siteId]/[deviceIndex]/[varValue]/[varIndex]/[who]/[ts]/[HMM]/[passCheck]/</<failure_url>[gatewaysyncUrl]/gw/GatewayService/SPutMpegFailed/s/[siteId]/[deviceIndex]/[varValue]/[varIndex]/[who]/[ts]/[HMM]/[passCheck]/</ </MediaUpload>

-   -   h. session server receives response to sendRequestEvent from        camera and posts response to gateway.    -   i. camera uploads to upload URL on gw webapp.    -   j. passCheck can be verified on server (based upon gateway        secret).    -   k. alternatively, spec calls for Digest Auth here.    -   l. endpoint responds with message digest password if the URI is        expected, otherwise returns non-response.    -   m. gw webapp stores video clip, logs history event.    -   n. event is posted to gateway for deltas.        Live Video (Relay)    -   a. Upon user login to portal, portal creates a media relay        tunnel by calling relayAPImanager create.    -   b. RelayAPImanager creates relays and sends ip-config-relay        variable (which instructs gateway to create media tunnel) to        gateway.    -   c. Upon receiving media tunnel create ip-config-relay command,        gateway posts openhome media channel create command to session        server with camera connected.    -   d. session server sends create media tunnel command to camera        (comprises camera relay URL on relay server).    -   e. Example URI from session server to camera:        /openhome/streaming/mediatunnel/create    -   f. Example XML body:

<CreateMediaTunnel> <sessionID>1</sessionID><gatewayURL>TBD</gatewayURL> <failureURL>TBD</failureURL></CreateMediaTunnel>

-   -   g. GatewayURL is created from relay server, port, and sessionId        info included within ip-config-relay variable.    -   h. camera creates a TLS tunnel to relay server via POST to        <gatewayURL>.    -   i. When user initiates live video, portal determines user is        remote and retrieves URL of Relay server from relayAPImanager.    -   j. Upon receiving a user pole connection on the relay server        (along with valid rtsp request), relay sends streaming command        to camera: example: rtsp:://openhome/streaming/channels/1/rtsp    -   k. Upon user portal logout, portals calls relayAPImanager to        terminate media tunnel.    -   l. RelayAPImanager send ip-config-relay variable to terminate        media tunnel.    -   m. Gateway sends destroy media tunnel command to camera via        XMPP.        Camera Firmware Update    -   a. Gateway checks camera firmware version; if below minimum        version, gateway sends command to camera (via session server) to        upgrade firmware (command: /openhome/system/updatefirmware).    -   b. Gateway checks firmware update status by polling:        /openhome/system/updatefirmware/status.    -   c. Gateway informs portal of upgrade status.    -   d. Camera auto-reboots after firmware update and reconnects to        Session server.        Camera First-Contact Configuration    -   a. After a camera is added successfully and is connected to the        session server for the first time, gateway performs first        contact configuration as follows.    -   b. Check firmware version.    -   c. Configure settings by: download config file using        /openhome/sysetm/configurationData/configFile; or configure each        category individually (configure video input channel        settings—/openhome/system/video/inputs/channels; configure audio        input channel settings (if        any)—/openhome/system/audio/inputs/channels; configure video        streaming channel settings—/openhome/streaming/channels;        configure motion detection settings—example:        PUT/openhome/custom/motiondetection/pir/0; configure event        trigger settings—example: PUT/openhome/custom/event).    -   d. Reboot camera (/openhome/system/factoryreset) if camera        responds with reboot required.

Embodiments described herein include one or more protocols enablingcommunications between one or more system components described herein(e.g., gateway, touchscreen, IP devices, security system, etc.). Moreparticularly, details follow of interface specifications (SECURITY,MONITORING AND CONTROL (SMA) SERVICES COMPACT PROTOCOL) in an exampleembodiment of the integrated security system described herein.

SMA Services Compact Protocol

1 Introduction

The iControl iConnect Security, Monitoring and Control (SMA) servicesprovide customers with a way to access and control their home and itssecurity system remotely over the internet. There are a variety ofservices and client platforms available. The protocol discussed hereinis mainly focused on security panel-related events and control, withoptional support for monitoring/control (“M/C”) devices such as lightsand locks.

This document specifies the serial protocol used between the premisesCPE (e.g. a security panel) and the iControl server. The CPE on thepremises has a communications pathway to an iControl SMA server. Forstand-alone panels, this connection is generally a GPRS connection toone or two secure APNs. Some panels may use SMA to communicate with aniHub, either in the same physical device or in a multi-device solution.Here, the communication paths are likely over a local IP network, eitherwifi or a network connection internal to a shared board. If the iHubsoftware is on the same device, the protocol is also designed to supportcommunication directly over serial port. The protocol is not, strictlyspeaking, dependent on any particular underlying physical transport.However, TCP/IP and UDP are the expected transports and are referencedthroughout.

2 SMA Services Summary

The SMA services that this protocol supports allow a user to monitor,control, and configure a security panel in their home. The userinteracts with their system via an iControl server, or via clientsoftware written to use the SMA protocol directly. The iControl serversmay, in turn, use SMA for direct communication to the panel, or maycommunicate with separate software (“iHub”) that acts as a local SMAserver and manages the panel via SMA. In brief, this functionality mustallow the user to:

-   -   1. Interactively See the Status of their System        -   Users can log into a web portal, or open a mobile            application, and see what arm and alarm states their alarm            system is in. They can also see the complete state of all of            their zones, irrespective of whether or not there is an            alarm. This includes fault (open/closed) statuses as well as            tamper faults, low battery, etc. If the CPE supports M/C            devices, it also includes the current state of M/C devices.    -   2. Interactively review a history of events.        -   As above, when they are remotely logged into their system,            users can review a history of everything from alarms to            routine door openings and closings.    -   3. Remotely arm and disarm their system.        -   4. Remotely control M/C devices such as lights, door locks,            etc.

The protocol includes extensions to allow for more complete control overthe panel. Including:

-   -   1. Add, modify, and manage sensor, user, partition, and other        panel configurations. This will be the basis for more various        levels of iControl UI, from installer and activation        applications to simple sensor renaming.    -   2. Configure and drive Downloader functionality for panel        configuration and firmware update. This downloader support is        device/deployment specific.    -   3. Drive remote upgrades to the panel's firmware.    -   4. Provide for integrated and streamlined panel replacement.        3 Architecture

See FIG. 25.

The iControl SMA services serve as an adjunct to an existing alarmreporting service. The SMA protocol is not intended to be used forprimary alarm reporting. Standard alarm reporting is done through thecloud depicted above, which may include cellular, broadband internet, orPOTS pathways. The standard alarm path always has priority, so anyevents that need to be reported there need to be done before contactingthe SMA servers (if the SMA connection is shared with the alarmreporting path.) On the other hand, the nature of the vast majority ofthe events sent to the iControl servers (i.e. casual open/close events)is such that only a small percentage of events sent to the server willalso generate alarms to the alarm receiver.

This specification deals solely with the three paths between the CPE andthe iControl servers depicted above. The alarm reporting cloud isoutside the scope of this specification.

Not shown in FIG. 25 is any mention of the network that the CPE uses toconnect to the SMA server. While the specific APN architecture is beyondthe scope of this specification, the protocol provides a configurationAPI for flexible and extensible configuration of any properties thatneed to be set based on the APN architecture. For example, differentserver addresses can be specified for each APN that the CPE uses (e.g.primary and backup) for its network connection.

4 Design Objectives

The main objectives of the design of this protocol are:

-   1. Compactness    -   a. Minimize overall network traffic        -   i. Both GPRS and SMS traffic are considered, as well as the            transport protocol overhead involved.        -   ii. Minimize number of SMS messages-   2. Extensibility    -   a. Applicable to multiple different panel implementations    -   b. Able to readily incorporate new panel features without        overhauling the protocol.-   3. Accuracy    -   a. Keep the server in sync with the CPE.        -   i. Compact format permits more information in each message        -   ii. Efficient resync when out-of-sync state is detected            5 Remote Commands/Queries Vs. Asynchronous Event Reports

In addition to an out-of-band SMS path, which is used to wake up orconfigure some CPE, FIG. 1 shows two communication channels between theCPE and the server. The “Remote Control” channel is typically a TCPconnection used when the server is actively requesting information orsending commands to the CPE. The “Async Event Report” channel is often aUDP connection used by the CPE to send unsolicited message about eventsoccurring on the panel.

Once a system is initialized, the remote control connection is usedalmost exclusively while a user is actively interacting with the system.The Remote Control channel allows the user, via the server, to sendvarious arm and disarm commands and to control M/C devices.

Remote Control messages are divided into Commands and Queries. Queriesare used to get information about the state of the system, and arecompleted when the panel responds with that information. Queries do notchange the state of the panel. Commands, on the other hand, are actionstaken to change some state of the panel (rename a zone, arm, bypass azone, etc.) Their responses do not include additional data except for anerror code indicating immediate problems with the Command such asmissing parameters. The successful completion of a command should resultin some state change (or failure mode) on the panel, which is reportedby an Asynchronous Report (below) of some kind. A Command should not beassumed to have “completed” until the desired state change reported viaan Async Report.

During initialization, or whenever the server decides that it needs toconfigure or resynchronize with the panel, the server will use theremote control connection to request any information it desires.

The second path shown (“Async Reports”) need not be connection-based.Routine events can happen and need to be reported dozens of times a day.In many deployments with limited connectivity, it is inefficient tocreate a new TCP remote control channel to report each event, or to keepa TCP connection open continuously. Hence events are reported in realtime (with caveats) as they occur via the Async Event Reporting channel.The goal is to keep each event and its acknowledgement as small aspossible, including protocol overhead. These asynchronous events areexpected to be sent over an always-on connection such as a serial line,or as UDP datagrams, as opposed to TCP connections. Tightly integratedsystems with little networking overhead between the SMA server and thePanel may still use an always on TCP Connection. The protocoleffectively handles non-connection-based asynchronous event reporting

6 Data Format and Endianness

6.1 Numeric Values

All numeric data in this protocol are sent in big-endian (AKA “network”)format, meaning that the most significant byte is the first one sent.Similarly, multi-byte values (e.g. MAC or IP addresses) are sent inorder.

6.2 Timestamps

The CPE MUST report the time that an event occurred, via a 48-bitinteger timestamp that represents the number of milliseconds after agiven epoch. The CPE will be sent the “current” timestamp with eachcommand or acknowledgement from the server. If the CPE is connected tomultiple SMA servers, each may have a different basis for the timestamp.Regardless of what other time references the CPE might have, alltimestamps sent to the server must be in reference to the current timesent down to the CPE from the server.

The CPE should not make any assumptions regarding what epoch is used tocalculate the current time.

While the granularity of the timestamp is one millisecond, it is not arequirement that the CPE be able to timestamp events that accurately.However, in order to preserve the proper order of events, no two eventsshould ever have an identical timestamp. Simultaneous events (such as aZone event which causes both an Alarm and a Zone Status change) shouldadd a millisecond between events to guarantee uniqueness.

6.3 Basic Message Structure

All protocol messages have a similar structure, with framing dependenton the system architecture, wrapping a message frame divided into aHeader identifying the message and a payload which may be encrypted:

Frame Channel Message Payload Frame Footer Header Header (possiblyencrypted) (May be empty)6.4 Protocol Version Number

A 1-byte protocol type/version number is included as the first byte ofeach message header. This allows the protocol to be expanded laterwithout impacting variations in framing or requiring changes to futuremessage header layout. If the CPE receives a message with a versionnumber that it does not support, it must respond with a NAK message overthe same channel that contains no payload, with the version number inthe header set to the CPE's preferred version.

6.5 Encryption

-   -   1. Message definitions for each type of channel are defined        below. Each Channel is divided into a Header and a Payload. The        Header is always sent unencrypted. The Payload may or may not be        encrypted and padded, depending on the settings in the Header.        The only encryption method currently supported is CBC, described        in        Appendix A. AES/CBC-256 with Initialization Vector.        7 Framing

The initial version of the protocol assumed that Async Events were sentover a packet protocol (UDP) and Remote Requests over a reliable streamprotocol (TCP.) Each had a different framing mechanism based on theexpected transport protocol. Frames were assumed to start from the firstbyte of the stream, and all include a size at a specific place in theheader. This makes it difficult to recover from a dropped byte andre-sync framing over a less reliable transport mechanism.

For version 2+, the framing used is tied to the transport mechanism,independent of the underlying message type, allowing a system to sendRemote Requests over a UDP stream, or Async Events over a TCPconnection. This also expands the protocol for use over a serialconnection using HDLC framing. Each system should agree on the framingused at each connection, and for each data channel (Remote Requests,Async Events) in that particular deployment.

Each framing mechanism should provide for two things:

Size information for each frame.

A channel identifier for each frame.

The channel identifier allows the rest of the protocol to identify whattype of data is being sent over that channel, and is used to interpretthe header at the start of that data frame. Currently, there are threetypes of headers:

System Control (including Remote Initiation)

Remote Requests

Asynchronous Events

7.1 Channel Type Enumeration

For compatibility with v1, Channels are identified by a two byte SOH.

Channel Identifier/ SOH Meaning 0x3663 System Control 0xaa55 RemoteRequest or Response 0xffee Asynchronous Event or Acknowledge7.2 TCP Framing

Frames sent over TCP are assumed to have their data integrity checked inthe lower layer, and to never lose bytes. TCP is streamed oriented,though, and thus requires fairly simple frame header to allow the systemto identify the channel number and size of each frame. TCP Frames don'tuse a Frame Footer.

Offset Size Name Discussion 0 2 Channel 0xaa55 for the Remote ControlChannel ID/SOH 2 2 Size Number of bytes to follow (total message size -4.) 4+ (Size) Frame Data Channel Header byte 0 is byte 4.7.3 UDP Framing

UDP Frames are fairly simple, beginning with the same SOH/ChannelIdentifier used by TCP frames, followed by the Packet data. A frame is asingle UDP packet, and the Frame size is obtained from the networklayer. There is no Frame Footer.

Offset Size Name Discussion 0 2 Channel ID/SOH 0xffee for the AsyncEvents channel 2+ (UDP Frame Data Channel Header byte 0 is UDP Size - 2)byte 2.7.4 HDLC Framing

HDLC is the High-level Data Link Control protocol, a standardized way ofpassing framed data, usually over a serial connection. It includesframing, error checking, and control mechanisms for retransmission andstation status.

The HDLC Frame Header is:

Offset Size Name Discussion 0 1 Flag 0x7E This may also be the End Flagof the previous message. 1 2 (Destination) Address Channel SOH (0x3663for the System Control Channel) 3 1 Control Unused, set to 0. 4+ AnyEscaped Data See 7.4.1 for escape sequence.

HDLC Frames also use a frame footer:

Offset Size Name Discussion N − 2 2 16 bit CRC, according CRC-CCITT,calculated to HDLC spec over the Escaped N 1 Flag 0x7E This may also bethe Start Flag of the next message.7.4.1 HDLC Escape

In order to guarantee that frames can be recovered, the Flag byte (0x7e)must be used uniquely as a frame delimiter. To guarantee this, all flagbytes in the body of the frame need to be escaped. When creating theframe:

-   -   1. Replace all occurrences of 0x7d (The escape character) with        two bytes: 0x7d 0x5d    -   2. Replace all occurrences of 0x7e (The flag character) with two        bytes: 0x7d 0x5e

When the recipient needs to recover the frame data, the escape processis reversed:

-   -   1. For each occurrence of 0x7d, remove the 0x7d byte and XOR the        next byte with 0x20.

Note that the CRC is performed over the Escaped Data. The CRC checkshould be performed before replacing escaped bytes.

7.4.2 HDLC Frame Check

HDLC frames include a frame check sequence to guarantee data integrity.This is a 16 bit CRC (CRC-CCITTT) calculate over the Address, Control,and (escaped) data bytes. If the CRC fails, the station (server or CPE)should discard the message and not respond or change state.

8 SMA Object Model

SMA messages query, drive, or report on changes in various parts of aCPE Panel. Normally, a Request, Reply, or Report payload contains asingle Object (which may be extended with more sub-Objects) describingeither a parameter of the Request, the results of a Query, or thedetails of a Report. This section gives a general overview of thestructure of those Objects and the generic objects types. SpecificObjects are more fully discussed in their own Sections.

8.1 Object IDs

Persistent, enumerated objects in the system will usually have an objectID as part of their structure. These object IDs (along with knowledge ofthe specific Object type) are used as references to that specificobject. For each Object type, Object IDs should be unique across thesystem. If the panel internally tracks Users or Zones on a per-partitionbasis, such that partition 1 has a Zone with ID 1 and partition 2 canalso have a Zone ID 1 with different configuration, the Panel may needto encode the Partition ID into the User or Zone code used for SMA.

Object IDs of 0xff or 0xffff have special meaning, and should not beassigned to actual objects. Usually, the 0xff/0xffff IDs mean that theID is unknown, unassigned, or should remain unchanged. Most commonly,the various Add commands will use 0xff/0xffff to tell the Panel toassign an ID to the newly created object. Most Object IDs are one byte(allowing for 254 objects of each type) with the exception of Zones,which are 2 bytes (allowing for 65535.)

8.2 Object Encoding

Objects are encoded as a series of bytes, included in the payload of aRemote Command or Asynchronous Event. All objects should be parsabledirectly, without needing context from the message in which they weresent or other state of the system. The first byte of each objectidentifies its type, from the Object type enumerations below in 8.6

This is then followed by one or two bytes indicating the length of theobject's data (Not including the type and size bytes.) Objects with0-127 bytes of data (most objects using this protocol) will contain asingle size byte. Larger objects should set the MSB (bit 7) in the firstsize byte to indicate that a second size byte follows. Two-byte sizesare interpreted as a 15 bit length (with the first byte the mostsignificant, as per the endianness in 6.1) ignoring the MSB from thefirst byte used to flag a large size. Thus, objects can be up to 32768bytes in size.

This is then followed by the object's data, encoded according to theobject's type, specified in the remaining subsections.

Offset Size Name Discussion 0 1 Object Type See Object Type Enumeration1 1-2 Object Size (O) Remaining object size in bytes. 127 or less -Single byte of size. 128+ - Two bytes of size data, ignoring MSB. 2-3 OObject Data Any data remaining after parsing a complete object should beinterpreted as a new sub-bject (8.2.1)8.2.1 Extension

The expected data size for each object can also be determined directlyfrom the object type and data (for example, a Zone ID Object always hastwo bytes of data.) Any remaining data in the object should beinterpreted as an additional Object, beginning with its own Object Typeand Size byte(s.) This is commonly used to include a PIN Object (12.4.3)for various Remote Requests. Object extension can also be used tosupport additional panel specific variants of existing Async Reports andCommands using the NameValue Object.

For Example, a Bypass Zone Command passes a Zone ID object as aparameter. This command will often require a PIN to be included. ThisPIN would be added as an extension to the Zone ID object:

Offset Size Name Discussion 0 1 (Object Type) 8 - Zone ID 1 1 Size 10 -10 Bytes of data follow 2 2 Zone ID 2 byte Zone ID 3 1 (Extension Object(10 − 2 = 8 bytes of Extension Type) Object) 25 - PIN Code (See ObjectType Enumeration) 4 1 Extension Size 6 - 6 bytes of data to follow 5 1PIN Length 5 - PIN Length 6 5 PIN “12345” UTF-8 encoded.8.3 Nothing Object

Some Remote Control Requests don't need to specify any parameters bydefault. Remote Control Responses to Commands should also return nodata. These Messages can either send an empty payload Object (whichshould not be considered an error) or a “Nothing” Object. The SMA serverwill only accept an object of type Nothing in these responses. Usually,a Nothing object will have no data (Type=0, Size=0,) but it is possibleto Extend a Nothing object with sub-objects if appropriate (Type=0,Size >0, Data is an object starting with Object Type Byte.)

8.4 Fixed Length Element Array

It's useful to be able to send multiple objects of the same type withoutrepeating type or size information. The Fixed Length Element ArrayObject is designed for this. The Array Data begins with a one byte Typefield, followed by a one byte element count. Each (Element Size) bytesof data in the remaining Object data should be interpreted as an Objectof type (Element Type) and length (Element Length). The Object Size ofan un-extended Fixed Length Array Object size should be (ElementCount)*(Element Size)+3 for the Element Type, Count, and Size fields.Remaining bytes of data are interpreted as an object extension, as8.2.1.

Offset Size Name Discussion 0 1 Element Type Enumeration, See 8.6 1 1Element Count (C) Number of Elements in the Array 2 1 Element Length(L)Length of each Element 3 L Element 0 First Element in the Array, of Type(Element Type) 3 + L L Element 1 Second Element, of Type (Element Type). . . . . . . . . . . . 3 + (C − L Element (C − 1) Last Element in theArray, of 1) * L Type (Element Type)8.5 Variable Length Element Array

Not all objects (particularly named objects) have a fixed length, but itis still useful to send multiple objects together. These are representedusing variable Length Element Arrays Objects. These Array objects beginwith a one byte type field, followed by a one byte count field. The nextbyte is the total length of the first Element of the array. The nextbyte after that object should be interpreted as the length of the nextobject, and so on. There should be (Element Count) total elements worthof data, and the total Size of all elements, plus 3-4 bytes for theArray object, should equal the total size of the Array element.

Offset Size Name Discussion 0 1 Element Type Enumeration, See 8.6 1 1Element Count Number of Elements in the Array 2 1 Element 0 Length (L0)3 L0 Element 0 Data 3 + L0 1 Element 1 Length (L1) 4 + L0 L1 Element 1Data ... ... ...8.6 Name Value Objects

Name Value objects are simple pairs of strings to pass arbitrary namedattributes. Name Value objects are included primarily to allow forarbitrary extensions of Configuration parameters to existing Objects.They may be included as Extensions (Section 8.2.1) of existing objectsto add more information to an object.

Offset Size Name Discussion 0 1 Name Length (N) Number of bytes in Namefield 1 N Name UTF-8 encoded Name String. 1 + N 1 Value Length (V)Number of bytes in Value field 2 + N V Value UTF-8 encoded Value string.8.7 String Objects

Offset Size Name Discussion 0 1 String Length (S) Total bytes in theString field. 1 S String UTF-8 Encoded String representing the series ofkeys presses, or text to be displayed.8.8 Object Type Enumeration

Object types are identified by a 1 byte value from the following table,which also serves as a list of the current object types in the SMAprotocol.

Type # Object Name Discussion 0 Nothing Place holder object. If Sizeis >0, contains an Extension (8.2.1) 1 Fixed Element Array Array ofelements with the same type and size (See 8.3) 2 Variable Element ArrayArray of elements with the same type but different sizes (See 8.5) 3Name Value A Name/Value attribute. (See 8.6) 4 Partition ID Single byteID (See 8.1) corresponding to a Partition Config object. 5 User IDSingle byte ID (See 8.1) corresponding to a User Code object. 6Controller ID Single byte ID (See 8.1) corresponding to a Controllerobject. 7 CMS Channel ID Single byte ID (See 8.1) corresponding to aUser Code object. 8 Zone ID Two byte ID (See 8.1) corresponding to aZone object. 9 Async Event A single Asynchronous event (See 11.9) 10Capability Specify the Capabilties supported over a connection duringCPE initiation. (See 9.3.4) 11 Panel Config Configuration informationfor the overall Panel. (See 12.1) 12 Panel Mode Intentional modeaffecting operation of the entire Panel (See 12.1.1) 13 CMS ChannelInformation about a channel to report alarm information over. (See 12.5)14 System Trouble Active Trouble on the Panel. (See 12.5.1) 15 ClockTime Wall clock time and data for the panel. (See 12.2) 16 Config StringCPE Configuration String, See Appendix B. CPE Interface Configuration 17Partition Config Configuration data for a single Partition (See 13.2) 18Arm State Arm state information for a single Partition (See 13.2.2) 19Partition Mode Intentional mode affecting operation of a singlepartition. (See 13.2.4 20 Alarm An active alarm, with reporting state.(See 14.1) 21 Zone Config Configuration data for a single Zone. (See15.1) 22 Zone Status The status of a single Zone, including faultinformation. (See 15.3) 23 Zone Reporting Reporting configuration for aZone. (See 15.2.1) 24 Zone Serial Number Panel/vendor specific uniquesensor ID (See 15.4.1) 25 User Code User information associated with aPIN code on the panel, and associated name information. (See 12.4.1) 26PIN Code PIN code entered on a controller (12.4.3) 27 Reserved 28Controller Describes a keypad or SMA server from which a User can takean action. (See 12.3) 29 String Generic Strings. 30 M/C CommandMonitor/Control Command (16.1) 31 M/C Report Monitor/Control Report(16.2) 32 Timestamp 6 byte Timestamp (See 6.2) 33 CPE ID 6 byte CPE ID(See 9) 34 Opaque Panel Event Used for direct query of the Panel's eventQueue. (See 12.7.1) 35 Panel Event Info Information about the PanelEvent Queue (See 12.7.2) 36 Panel Event Index 2 byte Index into thePanel Event Queue. 37 Configuration Setting The description of aconfiguration setting for Descriptor Object a partition or panel. See12.1.3 38 Configuration Setting Object The value of a configurationsetting for a partition or panel. See 12.1.4 39 Config Setting ID Indexfor Config Setting Descriptor or Object. See 12.1.3 40-255 Reserved9 System Control Channel

The first channel used to establish a connection between the CPE paneland the SMA server is the system control channel. This channel normallyuses the same transport path as the Remote Control channel. It is usedto negotiate specific settings of the CPE-Server session, and tell theserver to prepare for the possibility of receiving new Async Events fromthis CPE client. The CPE will always initiate connections. Manydeployments will include an out-of-band SMS wake mechanism to allow theserver to prompt known clients to begin session initiation. See AppendixC. SMS WAKE Message

9.1 System Control Channel Header

System Control message all being with a header identifying the CPE, andthe type of payload included:

Offset Size Name Discussion 0 1 Protocol Version 2 1 1 Encryption Type0 - None 1 - AES CBC with IV. 2 6 CPE Unique ID Usually the MAC address.8+ (Frame Payload Size - 8)9.2 System Control Payload

All system control messages begin with a message type, followed by Datawhose format depends on the message type:

Offset Size Name Discussion 0 1 Message Type 1 0+ Data Format depends onMessage Type.9.2.1 System Control Message Type Enumeration

The following System Control messages are currently defined:

Value Name/Meaning Payload Direction 0 CPE Initiation None CPE to Server1 Capability Query Capabilities Object Server to CPE (9.3.4) 2Capability Response Capabilities Object CPE to Server See (9.3.4) 3Capability Acknowledge Capabilities Object Server to CPE See (9.3.4) 4Set Timestamp Timestamp Object Server to CPE 5 Timestamp AcknowledgeTimestamp Object CPE to Server 6 Get Timestamp None Server to CPE 7Connected None Server to CPE 8-255 Reserved9.3 CPE Initiation

The CPE initiates the remote control TCP connection. It will normally doso on panel boot, when it is told to do so by an out-of-band “wakeup”message sent in an SMS (see appendix K), when a previous persistent TCPconnection closes or has an error, or when an Asynchronous Acknowledge(11.6) response is received with the “Command” byte set to “0x1(Initiate Remote Connection.” To initiate the connection, the CPEperforms whatever tasks are required to prepare the transport channelagreed on for this deployment (usually, connecting to the correct APN,routing to the internet, resolving the server IP by DNS, etc.)

The IP addresses and ports that the CPE uses for this connection arepre-configured, possibly via a separate out-of-band system configurationmessage usually sent via SMS (see Appendix B. CPE InterfaceConfiguration).

When the CPE has initialized and is ready to being receiving RemoteRequests, it should send a Remote Initiation over the System ControlChannel. This is a System Control message with the CPE Initiationmessage type (0x0) and no data. The server will then respond with eithera Get Timestamp command, Set Timestamp command, or a Capabilities Queryover the System Channel.

Once the server has agreed to capabilities and is satisfied with theclient's time base, it will send the Connected message. The clientshould not send Asynchronous events until the Connected message isreceived.

9.3.1 Timestamps

The Timestamp (a 48 bit millisecond value discussed in section 6.2) fora particular session should be established during session initiation, bythe SMA server. This value can be updated over the System ControlChannel once established. When the CPE receives a Set Timestamp command,it should set the timestamps in all replies relative to that base. Sincedifferent SMA servers may use different bases for their timestamps, theCPE is likely to need to record a separate timestamp offset for eachconnection, from some internal timestamp basis.

A Timestamp value of all 0xff can be used if the Panel doesn't havetiming information about the time of an event being reported.

When the Client receives a Get Timestamp command, it should return aTimestamp Acknowledge with its current time. If the Client isre-establishing a previous command connection, it should continue usingthe previous time base. If no previous connection has been established,the client should respond to Get Timestamp requests with all 0xff. Thisallows the server to identify clients with existing connections andprevent having to re-establish a new time base and interrupt their flowof Asynchronous events.

9.3.2 Capabilities

Different types of panel may support different sets of features. Inorder to allow panels with more limited sets of functionality to keep upwith changes in the protocol specification, messages are classified byCapability. Once the client connects, the server is expected to Querythe CPE to determine what Capabilities are supported.

9.3.3 Capabilities Query

The Capabilities Query message uses the System Control Channel Header,the payload is a Capabilities Object describing the Capabilities of thisSMA Server. Most Servers are expected to support at least the PanelOperation Capability, but some (SMA Servers acting as wireless keypads,for example) will not drive Panel Configuration or other CapabilityTypes.

The CPE should respond with a Capabilities Response Message. Thismessage includes a Capabilities Object which includes a subset of theCapability Types supported by the Server.

The Server finalizes the Capabilities to be used for this SMA sessionwith a Capability Acknowledgement message. The Capabilities object ofthis message should match that in the Capabilities Response Message. ThePanel should only send Async events for Capability Types agreed to inthis handshake. Similarly, the Server should only send Remote Requestswhich match a Capability Type agreed to in the handshake.

9.3.4 Capabilities Object

Capabilities is an object (with Object type 10, see Section Object TypeEnumeration 8.8) containing a count of supported capabilities, followedby one by identifying each capability supported.

Offset Size Name Discussion 0 1 Capability Count (C) Number ofCapability records in this message. 1 1 Capability Type #1 This CPSsupports the indicated Capability Type. . . . 1 1 + C 1 Capability TypeC This CPE supports the indicated Capability Type

Capabilities that aren't reported are assumed to be unsupported by theCPE.

9.4 Capability Type

Type # Purpose Discussion 0 Reserved 1 Panel Operation Panel Arm/Disarmand Alarm events. Typical Keypad interactions. 2 Panel ConfigurationAdding, removing, renaming Partitions, Zones, etc and managing panelfirmware 3 Monitor/Control Monitor and Control of lifestyle devices.4-255 Reserved10 Remote Control Channel

The Remote Control Channel is used by the server to initiate Requests(Commands and Queries) on the CPE. While the protocol supports multipleoutstanding remote commands, the panel usually has limited ability tohandle requests. As such, the server should normally only have oneRemote Control request outstanding at a time, and wait until theprevious command has been responded to send a new one.

10.1 Remote Channel Header Format

The header is a constant size (8 bytes) and is unencrypted.

Offset Size Name Discussion 0 1 Protocol Version 2 1 1 Encryption Type0 - No Encryption 1 - AES/CBC 256 with IV 2 6 Timestamp/ Time of theRequest. Responses Message ID should set this field to the Message ID ofthe Request Payload it is responding to.10.2 Request Payload Format

The payload varies in size, and may or may not be encrypted (dependingon the encryption type byte in the header). If the payload is encrypted,it is padded by the appropriate number of bytes to make the total sizeof the payload a multiple of 16. Pad bytes are all set to the number ofpad bytes (1-16) in the unencrypted data (per RFC 3852 Section 6.3).Unencrypted payloads need no padding (0 bytes.)

Offset Size Name Discussion 0 1 Capability Capability class of thiscommand. 1 1 Request Type See Request Enumerations in Section 10.4 2Varies Request A single Object, depending (Req Size) Parameter on theRequest Type. Multiple parameters should be passed as Extensions of thebase object. (8.2.1) See Request Enumerations in Section 10.4 2+ ReqVaries Pad Bytes Size ranges from 0-16 Size bytes, depending onencryption and padding.10.3 Response Payload Format

The payload varies in size, and may or may not be encrypted (dependingon the encryption type byte in the header). If the payload is encrypted,it is padded by the appropriate number of bytes to make the total sizeof the payload a multiple of 16. Pad bytes are all set to the number ofpad bytes (1-16) in the unencrypted data (per RFC 3852 Section 6.3).Unencrypted payloads need no padding (0 bytes.)

Offset Size Name Discussion 0 1 Capability Capability ID of the Requestwe're responding to. 1 1 Request The Type of the Request we'reresponding Type to. 2 1 Error Type error code. 0 for OK, 128+ are CodeMessage Type specific (See 17) 3 Varies Response An object (possibly anArray) with type (Resp Data dependent on the Request Type. ReponsesSize) to Commands should include NO data. See Request Enumerations inSection 10.4 2+ Resp Varies Pad Bytes Size ranges from 0-16 bytes,depending on Size encryption and padding.10.4 Remote Control Requests and Responses

These are the values that can be sent from the server to the CPE in aremote control downlink request (either a Query or a Command.)

The Panel should always return a Remote Response immediately uponreceiving and parsing the request, with any error codes immediatelyidentified. If the request is a command, it will change the state of thePanel, but the server should *NOT* assume that the command has beensuccessful until the state change has been reported through an AsyncEvent. Query requests, in contrast, return the requested information aspart of their Remote Response, and are completed once the response isreturned.

10.4.1 Panel Operation Requests

The first Capability includes commands for basic panel operations,allowing the server to get basic configuration about the partitions andzones in the system, and perform basic panel operations, mostly centeredaround arming and disarming the system.

10.4.2 Remote Command Type (Capability=1 [Panel Operation])

Parameter Object to Response Object Query/ Value Meaning CPE from CPECommand 0 Not used, NOOP Nothing (8.3) Nothing (8.3) Query 1 Get ZoneConfig By Partition Partition ID Variable Element Query Array of ZoneConfig objects for all Zones with access to the specified partition. 2Get Zone Config List Nothing (8.3) Variable Element Query Array of ZoneConfig objects for all Zones on the panel. 3 Get Zone Status ByPartition Partition ID Fixed Element Array Query of Zone Status objectsfor all Zones with access to the specified partition. 4 Set Arm State.Arm State (See 13.2.3) Nothing (8.3) Command (Usually Extended with aPIN Code Object) 5 Get Arm State Partition ID Arm State (13.2.3) Query 6Get Zone Status Nothing (8.3) Fixed Element Array of Zone Status objectsfor all Zones on the panel. 7 Send Async Status Report Zone ID Nothing(8.3) Command This should cause an Async Event with Zone Status for therequested Zone. 8 Bypass One Zone Zone ID (Extended Nothing (8.3)Command with a PIN Code Object) 9 Bypass All Open Zones Partition ID(Extended Nothing (8.3) Command with a PIN Code) (12.4.3) 10 Set ZoneReporting Fixed Element Array Nothing (8.3) Command of Zone ReportingObjects (See 15.2.1) 11 Get Zone Reporting Nothing (8.3) Fixed ElementArray of Zone Reporting Objects (See 15.2.1) 12 Get System TroublesNothing (8.3) Fixed Element Array Query of System Trouble Objects(12.5.1) 13 Get Interface Configuration Nothing (8.3) Config StringQuery Appendix J. 14 Set Interface Configuration Config string, SeeNothing (8.3) Command Appendix J. 15 Bypass Bypass Group Partition ID(Extended Nothing (8.3) Command (See 15.1.2) with a PIN Code) (12.4.3)16 Unbypass Bypass Group Partition ID (Extended Nothing (8.3) Command(See 15.1.2) with a PIN Code) (12.4.3) 17 Silence All Troubles PartitionID (8.3) Nothing (8.3) Command 18 Clear All Troubles Partition ID (8.3)Nothing (8.3) Command 19 Get Alarms Partition ID Fixed Element ArrayQuery of Alarm objects (14.1) 20 Set User Alarm Alarm (See 14.1) Nothing(8.3) Command 21 Get Partition Mode Partition ID Partition Mode (SeeQuery 13.2.2) 22 Set Partition Mode Partition Mode Nothing (8.3) Command(13.2.2) 23 Unbypass Zone Zone ID (Usually Nothing (8.3) CommandExtended with a PIN Code Object) 24 Unbypass All Zones PIN Code (12.4.3)Nothing (8.3) 25 Get Partition Configs Nothing (8.3) Variable LengthArray of Partition Config Objects (13.2) 26 Get Partition ConfigPartition ID Partition Config Object (13.2) 27 Emulate Keypress String(Error! Nothing (8.3) Command Reference source not found.) 28 Get MyController ID Nothing (8.3) Controller ID Query 29 Get User ID PIN Code(12.4.3) User ID Query 30 Clear Alarm Alarm Object (See Nothing (See8.3) Command 14.1) 31 Clear All Alarms Partition ID Nothing (See 8.3)Command 32 Silence Alarm Alarm Object (See Nothing (See 8.3) Command14.1) 33 Silence All Alarms Partition ID Nothing (See 8.3) Command34-255 Reserved10.4.3 Panel Configuration Requests

The Panel Configuration capability includes more detailed commands toquery panel configuration. It also includes commands for adding,removing and modifying elements of panel configuration.

Panel Configuration includes commands to configure and initiateconnections to a vendor specific Downloader, which can manage deviceconfigurations remotely.

Panel Configuration also includes commands to drive panel specificfirmware upgrades.

Most Panel Configuration Requests follow a fairly straightforward Get,Add, Change, Remove model to get information about and modify aparticular object in the Panel's configuration. If the server's requestdoes not intend to specify or change a particular field, that filedshould be set to either length=0 (for variable length fields such asNames) or all is (0xff or 0xffff usually) for IDs and other numericdata. Most commonly, an Add Request should set the Object ID field to0xff/0xffff.

If a field cannot be changed by an Add/Change command, the requestshould return an “Attempt to change fixed attribute” error (Error #17,See 17.) If the Add/Change command specifies a fixed field with thecurrent value (in other words, no change is required) that should notcause an error. If the Add/Change fails, NO data should be modifiedbased on the command.

10.4.4 Remote_Command_Type (Capability=2 [Panel Configuration])

Parameter Object to Response Object Query/ Value Meaning CPE from CPECommand 0 Change Panel Mode Panel Mode object Nothing (8.3) Command (See12.1.1) 1 Enter Zone Learn Mode Partition ID Nothing (8.3) Command 2Accept Zone Learn Zone ID Nothing (8.3) Command 3 Reject Zone Learn ZoneID Nothing (8.3) Command 4 Leave Zone Learn Mode Partition ID Nothing(8.3) Command 5 Add Zone By Serial Number Zone Serial Number Nothing(8.3) Command (See 15.4.1) 6 Set Zone Config Zone Config (15.1) Nothing(8.3) Command 7 Remove Zone Zone ID Nothing (8.3) Command 8 Add UserCode User Code object Nothing (8.3) Command (12.4) (ID = 0xff) 9 SetUser Code User Code object Nothing (8.3) Command (12.4) 10 Remove UserCode User ID Nothing (8.3) Command 11 Add Partition Partition Configobject Nothing (8.3) Command (ID = 0xff) 12 Change Partition ConfigPartition Config object Nothing (8.3) Command (13.2) 13 Remove PartitionPartition ID Nothing (8.3) Command 14 Add CMS Channel CMS Channel objectNothing (8.3) Command (See 12.5) (ID = 0xff) 15 Change CMS Channel CMSChannel object Nothing (8.3) Command (See 12.5) 16 Remove CMS ChannelCMS Channel ID Nothing (8.3) Command (See 12.5) 17 Set Panel Clock TimeClock Time object Nothing (8.3) Command (12.2) 18 Reserved 19 Reserved20 Set Downloader Config Variable Element Nothing (8.3) Command Array ofName Value objects (8.6) 21 Start Download Action Variable ElementNothing (8.3) Command Array of Name Value objects (8.6) 22 StartProgramming Action Variable Element Nothing (8.3) Command Array of NameValue objects (8.6) 23 Set Panel Config Setting Config Setting ObjectNone Command 24 Set Partition Config Setting Config Setting Object NoneCommand 25 Enter Controller Learn Mode Partition ID None Command 26Accept Controller Learn Controller ID None Command 27 Reject ControllerLearn Controller ID None Command 28 Leave Controller Learn ModePartition ID None Command 29 Add Controller By Serial Number ControllerSerial None Command Number (15.4.1) 30 Set Controller Controller ObjectNone Command (12.3) 31 Remove Controller Controller ID None Command 32-128 Reserved for future Command 129 Get Zone Serial Number Zone IDZone Serial Query Number object (15.4.1) 130 Get Users Nothing (8.3)Variable Element Query Array of User Code objects (12.4.1) 131 Get UserCode User ID User Code object Query (12.4.1) 132 Get Partition ConfigsNothing (8.3) Variable Element Query Array of Partition Config objects(13.2) 133 Get Partition Config Partition ID Partition Config Queryobject (13.2) 134 Get CMS Channels Nothing (8.3) Fixed Element QueryArray of CMS Channel objects (See 12.5) 135 Get CMS Channel Nothing(8.3) CMS Channel Query object (See 12.5) 136 Get Panel Clock TimeNothing (8.3) Clock Time Query object (12.2) 137 Get Panel ConfigNothing (8.3) Panel Config Query object (12.1) 138 Get User withPartition Access Partition ID Fixed Element Query Array of User CodeObjects (12.4.1) 139 Get Zone Serial Number Zone ID Zone Serial QueryNumber object (See 15.4.1) 140 Get Download Configuration Nothing (8.3)Variable Element Query Array of Name Value objects (8.6) 141 Get PanelEvent Info Nothing (8.3) Panel Event Query Queue Info Object (12.7.2)142 Get Opaque Panel Events Fixed Length Array of Variable Element QueryPanel Event Indices Array of Opaque (8.8) Panel Events objects (12.7.1)143 Get Panel Config Setting Config Setting ID Config Setting QueryDescriptor Descriptor Object (See 12.1.3) 144 Get Panel Config SettingConfig Setting ID Config Setting Query Object (See 12.1.4 145 GetPartition Config Setting Config Setting ID Config Setting QueryDescriptor Descriptor Object (See 12.1.3 146 Get Partition ConfigSetting Config Setting ID Config Setting Query Object (See 12.1.4) 147Get Controller Controller ID Controller Object Query (See 12.3) 148 GetController Serial Number Controller ID Serial Number Object (See 15.4.1)149-255 Reserved for future Queries10.4.5 Monitor Control Requests

The Monitor Control Capability is fairly generic, and used to pass datato and from specific devices in the system that the panel does not havedetailed knowledge or control over.

10.4.6 Remote_Command_Type (Capability=3 [Monitor Control])

Parameter Object Response Object Query/ Value Meaning to CPE from CPECommand  1 Monitor/ Zone ID M/C Command Command Control Object Command(16.1)  2-127 Reserved 128 Get Monitor/ Zone ID M/C Report Object QueryControl Status (16.2) 129-255 Reserved11 Asynchronous Event Channel11.1 Event Data Transmission

Event messages are sent to the server in a single UDP packet. In orderto guarantee delivery of these events without a connection, as well asdetecting lost messages, every event message must have a unique,sequential (no gaps) sequence number. The server will reply to the eventwith a UDP packet containing an ack with the same sequence number. TheCPE MUST 1) always send identical data when retrying a message with agiven sequence number, 2) recognize any ack that contains that sequencenumber as a positive acknowledgement and stop the retries, if any, and3) not send any messages with a different sequence number until either:

-   -   (a) the first message is acknowledged or    -   (b) the event retry timeout has elapsed.        11.2 Event Sequence Diagram

FIG. 26 shows three event messages being reported. The first (X) getsthrough and is acknowledged successfully. The second message (Y) is loston its first two trips to the server. The third attempt gets through,but the acknowledgement is lost on its way back. Finally, the fourthattempt (retry 3) and its acknowledgement both complete their tripsuccessfully. The CPE can then send message Z. Note that the CPE MUSTwait for message Y to be acked (or time out) before sending out eventmessage Z.

11.3 Asynchronous Event Message

An event message contains one or more event reports in a single message.Each of the events in the message must be in proper temporal order. TheCPE can safely assume that the server will properly handle this messageas idempotent, so it is safe to send it multiple times as long as thesequence number and data remain unchanged.

11.4 Asynchronous Event Channel Header

Each event message begins with the following header.

Offset Size Name Discussion 0 1 Protocol Version 2 1 1 Encryption 0 None1 AES/CBC with IV 2 6 System Typically the MAC address of the Unique IDnetwork interface. 8 1 Sequence Number 0-255. Increases by ONE for everysubsequent event message, except for heartbeats (reporting 0 events).(No gaps allowed). Rolls over to zero after 255. 9 1 Retry Count Zerofor initial transmission, increases by one for every retry. 10 6Timestamp Time this message was sent.11.5 Asynchronous Event Message Payload

The event header is immediately followed by the payload, which is anarray of Event Objects:

Offset Size Name Discussion 0 1 Array Object Type Variable LengthElement Array (2) (See 8.5) 1 2 Array Object Size Total Variable LengthArray Object length (See 8.2) 3 1 Array Element Async Event (9) (See8.8) Type 4 1 Event Count Number of Event Objects following 5 1 AsyncEvent Size of Event #1 Element Size (O1) 6 O1 Event #1 Element Data 6 +O1 1 Async Event Size of Event #1 Element Size (O1) 7 + O1 O2 Event #1Element Data . . . . . . . . . . . . 1 + Varies Pad Bytes Size rangesfrom 0-16 bytes, RespSize depending on encryption and padding.

The array of Async Event objects in a report payload should be includedone after the other in chronological order by Timestamp. The Arrayincludes the size of each event object. This data size may vary from thetotal size of the Async object, indicating an Extension (8.2.1) of theAsync Event object. The next event report will appear immediately, withno padding. Encryption padding is applied only to the event message as awhole.

11.6 Asynchronous Event Acknowledge Payload

The server will acknowledge each event message with the followingpacket. The CPE MUST consider all of the events sent within thecorresponding message as being acknowledged. Note that this ack messageis the only message that the server ever sends over the Async Eventchannel in response to an event report. This message must be consideredidempotent by the CPE and handled appropriately. That means that once ithas received an ack for a particular sequence number, it should simplyignore any subsequent acks. (Don't log it, don't consider it an error,etc). If the command byte is set to “Initiate Remote Control” the CPEmust do so as soon as possible (See 9.3.)

Offset Size Name Discussion 0 1 Command 0 - None 1 - CPE should initiateRemote Control11.7 Asynchronous Client Heartbeat

When an Asynchronous Event Message contains no payload (an Event Countof 0,) then the message will be treated as a Client Heartbeat. A clientHeartbeat message should not increment the Event Report Sequence Number.As a result, the sequence number used in the last Event Report should beused in the Client Heartbeat.

A server response to a heartbeat message is optional. As a result, thereshould be no retry by the client of a Heartbeat message. A serverresponse to a Heartbeat message, when sent, will follow the same formatas that for a typical Asynchronous Event Message. In practice, theserver will only send a response when an “Initiate Report Control”command is needed. The heartbeat interval is specified in the “hi”property of the “Set Interface Configuration” command (see appendix j).A Client Heartbeat should only be sent after the time specified by theheartbeat interval has passed since the last Asynchronous Event Messagetransmission.

The CPE will be configured to send a Client Heartbeat when no SMSchannel is available, for example, on a CPE with a broadband internetconnection and no GSM module.

11.8 System Events

System events are reported in real time. Any event that is not azone-related event is considered a system event. Thus it includes, whilenot limited to:

-   -   1. System armed (stay, away, instant, night, . . . )    -   2. System disarmed    -   3. Any alarm    -   4. Any alarm restore    -   5. Misc faults (low battery, tamper, comm fail, RF jam, . . . )        11.9 Async Event Object

Event Objects represent transitive events that occur on the panel,initiated at specific times. They include a sub-object detailing thestate change.

Offset Size Name Discussion 0 1 Capability See 9.4 1 1 Async Report TypeSee 11.10 1 6 Timestamp Time of event with millisecond granularity. 7Varies Object An Object from this chapter, which should be of the Typecorresponding to the Event Type below.11.10 Async Report Type11.10.1 Async Report Type (Capability=1 [Panel Operation]

Type # Purpose Payload Object and Discussion 1 Arm State Arm Stateobject (See 13.2.2) Change This should be Extended with a User ID and/orController ID to indicate who and where the state change was initiated.(See 8.2.1) 2 System Trouble System Trouble object (See 12.6) 3 ZoneStatus Zone Status (See 15.3) This may be extended with a User ID and/orController ID to indicate who or where the state change was caused (forBypass or other user caused events.) 4 Alarm Alarm Object (See 14.1) 5User Code User ID (8.8) changed Sent when a User's PIN Code, Tags, orPartition Access has changed. 6 Reserved 7 Config Change Nothing (8.3)Sent whenever the panel configuration has changed (the SMA server shouldrenew its Zone and Partition Config list). If the connection supportsit, a more detailed Capability 2 (Panel Configuration) Async Eventshould also be sent. 8 Alarm Cancelled Alarm object. (See 14.1) 9 KeyPress String (See 8.7) 10 Keypad Display String (See 8.7) 11 Reserved 12Partition Mode Partition Mode Object (See 13.2.4) Change 16-255 Reserved11.10.2 Async Report Type (Capability-2 [Panel Configuration])

Type # Purpose/Name Payload Object Type  1 Download Action VariableElement Array of Name/ Started Value Objects (8.6)  2 Download ActionVariable Element Array of Name Status Value Objects (8.6)  3 DownloadAction Variable Element Array of Name Completed Value Objects (8.6)  4Downloader Variable Element Array of Name Configuration Value Objects(8.6) Changed  5 User Code Added User Code (12.4.1)  6 User Code ChangeUser Code (12.4.1) (Also send Capability 1: User code changed)  7 UserCode Deleted User ID  8 Zone Learn Mode Partition ID (See Zone Learning,Entered Section 15.4)  9 Zone Added Zone Config (15.1) Sent when a Zoneis added directly, or a learned Sensor is accepted. 10 Zone Learn ZoneConfig (15.1) Detected The Server is expected to respond with either aZone Learn Cancel or Zone Learn Accept Remote Command. 11 Zone LearnZone ID Rejected 12 Zone Learn Mode Partition ID Exited 13 Zone ZoneConfig (15.1) Configuration (Also send Capability 1: Zone ChangeConfiguration Changed) 14 Zone Deleted Zone ID 15 Partition AddedPartition Config 16 Partition Partition Config Configuration Change 17Partition Deleted Partition ID 18 Controller Added Controller Config 19Controller Controller Config Configuration Change 20 Controller DeletedController ID 21 CMS Channel CMS Channel Added 22 CMS Channel CMSChannel Changed 23 CMS Channel CMS Channel ID Deleted 24 Panel TimeChange Clock Time (Corresponds to Timestamp in the Event.) 25 Reserved26 Panel Mode Change Panel Mode Object (12.1.1) 27 Programming VariableElement Array of Name Action Initiated Value Objects (8.6) 28Programming Variable Element Array of Name Action Status Value Objects(8.6) 29 Programming Variable Element Array of Name Action CompletedValue Objects (8.6) 30 Config Setting Configuration Setting ObjectChanged (see 12.1.4) 31 Controller Learn Entered 32 Controller LearnController Object (12.3) Detected 33 Controller Learn Controller ID(12.3) Rejected 34 Controller Learn Exited 35-255 Reserved11.10.3 Async Report Type (Capability=3 [Monitor/Control])

Type # Purpose Discussion 1 M/C Report M/C Report object (16.2) 2-255Reserved12 Panel Objects

Conceptually, the highest level object is the Panel itself. The Panel isidentified by its CPE, usually a 48 bit MAC address. The Panel objectmostly includes general information about the panel, along with someinformation on the overall state of the device, and commands directed atit may apply to any sub-parts. There should only be one Panel object foreach SMA connection. Multiple Panels should each connect to an SMAserver directly. The Panel object is used for:

-   -   All identifying panel information (vendor, type, software        version, CPE)    -   System Trouble(s) on the panel (Tamper, Jam, AC failure, Low        Battery, etc)    -   Modes that affect the operation of the entire Panel (Installer        Mode, Walk Test, etc)        12.1 Panel Config Object

Offset Size Name Discussion  0 6 CPE Usually a MAC Address, should matchthe CPE ID of all Async events from this panel.  6 1 Panel Mode CurrentPanel Mode, See 12.1.1  7 2 Panel Number of Configuration ConfigurationSettings for this Panel, Settings count starting from index 0. See12.1.3  9 2 Partition Number of Configuration Configuration Settings fora partition on Settings Count this panel, starting from Index 0. Allpartition must share the same set of Config Settings Descriptors. See12.1.3 11 1 Vendor Length(V) Byte length of Vendor String 12 V VendorName Vendor Name (UTF-8) 12 + V 1 Model Length (M) Byte length of ModelString 13 + V M Model Name Model Name String (UTF-8) 13 + V + M 1Firmware Version Byte length of Firmware Length (F) Version String 14 +V + M F Firmware Version Firmware Version String (UTF-8)

In addition to commands and configuration for these features, a Panel isassociated with a few sets of sub-objects that can be queried by RemoteRequests, or reported on by Asynchronous Events.

-   -   Clock Time    -   Controllers    -   User Codes    -   CMS Channels    -   Active System Troubles    -   Partitions        12.1.1 Panel Mode Object

This simple object is used to request or report a change in Panel modewithout changes to other Panel configurations, which are expected tochange very rarely.

Offset Size Name Discussion 0 1 Panel Mode Panel Mode Enumeration12.1.2 Panel Mode Enumeration

This enumeration describes operation modes that affect panel operationas a whole. Specific panels might not use any or all of these modes.This should only reflect intentional operation modes for the panel.Power loss or other failures are reflected with System Troubles.

Value Meaning  0 Normal Usage  1 Programming Mode - A specific mode toallow changes to the panel sensor list, user list, partitionconfiguration, etc.  2 User Programming Mode - A mode to allow limitedchanges to zone names and permissions.  3 Installer Test Report Mode -Zone events should sent Test Alarm reports instead of normal alarms.  4Walk Test Mode - Zone events don't cause alarms but are reported via SMAto verify sensor installation by an end user.  5 Installer Test Mode -Zone and keyfob events don't cause alarms or actions, to verifyinstallation by the installer.  6 Downloader Action in Progress -Configuration Invalid (See 18)  7 Firmware Upgrade in Progress -Configuration Invalid (See 18)  8 Factory Reset - The Panel'sConfiguration has been wiped, usually after a Firmware/Download actionand a reboot. The SMA server should return the Panel Mode to NormalUsage when this reset has been handled. See (18)  9 DownloaderCompleted - The Panel's configuration has been completely updated. TheSMA server should return the Panel Mode to Normal Usage when this resethas been handled. (See 18) 10-255 Reserved12.1.3 Configuration Setting Descriptor Object

This object describes a configurable setting of a panel or a partition.

Offset Size Name Discussion 0 2 Setting Index Index identifying whichsetting this is. 2 2 Name Length (N) Length of the Name 4 N Name UTF-8Encoded String with the name of this Config- uration Setting. 4 + N 2Constraint Length (L) Length of the Constraint descriptor. 6 + N LConstraint String UTF-8 Encoded String describing the constraints onthis Configuration Setting.

The Constraint String describes the possible values that are valid forthis setting. It should be one of:

Value Meaning NUM An integer value. NUM(max) An integer value between 0and max. NUM(min, max) An integer value between min and max. NUM(min,max, increment) An integer value between min and max. Values must bemin + an integer multiple of increment. NUM(x|y|z) An Integer valueselection. Values must be one of x, y, z STRING A String STRING(x|y|z)String selection. Values must be one of x, y, z.12.1.4 Configuration Setting Object

Offset Size Name Discussion 0 2 Partition ID Partition ID thisconfiguration setting applies to. 0xffff Indicates a panel-wideconfiguration setting. 2 2 Setting Index Index identifying which settingthis is. 4 2 Setting Length (L) Length of the setting String. 6 6 + LString UTF-8 Encoded String repre- senting the series of keys presses,or text to be dis- played.12.2 Clock Time

Panels also track clock time, often based on information from the celltower. This clock time may be separate from the timestamp used by thesystem, which should not be adjusted with changes to the system ClockTime. For all Clock Time fields, a setting of all 0xff means that valuehasn't been set on the panel.

Offset Size Name Discussion 0 2 Year Unsigned Year (0-65534) 2 1 Month 1(January)-12 (December) 3 1 Day Day of month (1-31) 4 1 Hour 1-23 5 1Minute 0-59 6 2 Milliseconds 0-60,000 8 1 TZ Data Length Length of theTZ Data String (TZ) 9 TZ TZ Data Time Zone Database Zone Name in UTF-8(Example: America/Los_Angeles) (http://www.iana.org/time-zones)12.3 Controllers

Controllers are hardware or software components of the system that canbe used to interactively control the panel. The most common example is ahardware Keypad, but the iHub software itself is a Controller, as wouldany touchscreen hardware communicating directly with the panel. AController object is used to identify where a particular action wasinitiated. A panel does not need to report any controllers if it doesnot differentiate events by hardware initiator:

-   -   An (optional) Name String    -   Type information

Offset Size Name Discussion 0 1 Controller ID Controller Number/Index 11 Controller Type See 12.3.1 2 1 User ID User Index associated with thisController (if any) 0xff If the controller isn't associated with anyUser. 3 1 Zone Count (Z) Number of Zones associated with this Controller(i.e. buttons on a keyfob, tamper, panic keys on a keypad, etc.) 0 ifthe Controller has no associated zones. 4 2 * Z Zone IDs Zone IDs ofeach Zone associated with this controller. 4 + 2*Z 1 Model Length (M)Length of the Model String for this Controller. 5 + 2*Z M Model UTF-8encoded Model string for this controller. Includes manufacturer and anyVersion string. 5 + 2*Z + M 1 Name Length (N) Length of the Name Stringfor this controller. 6 + 2*Z + M N Controller Name UTF-8 encoded namefor this Controller12.3.1 Controller Type Enumeration

This enumeration distinguishes between the various possible controllersin a system.

Value Meaning 0 Unknown 1 Wired Keypad 2 Wireless Keypad 3 TouchscreenKeypad 4 iHub SMA Server 5 Remote SMA Server 6 Keyfob 7 Encrypted Keyfob8-254 Reserved12.4 User Codes

User codes identify which PIN codes are active in this partition, andwhat permissions and interpretations each of those user codes shouldhave. A User code is shared across partitions, with the same accesspermission and other tags. Commands to change that user code change itfor all partitions that user accesses.

Some Panels might not report PIN information to bus/server queries.These panels should report a PIN length of 0 in response to Queriesabout a User Code.

12.4.1 User Code Object

Offset Size Name Discussion 0 1 User ID Index, the ID must be the sameacross all partitions this User has access to 1 1 Tag Count (T) Numberof Tags describing this user. 2 1 Tag 1 See 12.4.2 3 (T total) . . . TagT 1 1 PIN Length (P) PIN Length 0 to avoid re- porting for securityreasons. 2 P PIN UTF-8 Digits 1 1 Access Count (A) Number of Partitionsthis user has access to. 1 1 Partition ID 1 First Partition this userhas access to. 2 (P) . . . Partition ID P Other partitions this user hasaccess to. (one byte each.) P + 2 1 Name Length Number of bytes (NOTchar- acters) in display name. 0 for No User Name. P + 3 Varies Username Display name, UTF-8 encoded.12.4.2 User Tags

User Tags are used to identify specific attributes for a given User.Normally, all Users will contain at least one Tag for that user's accesslevel. A User has the same Tags (and thus, access permissions) acrossall partitions they have access to (reflected in the partition

Value Meaning 0 Unused 1 Dealer 2 Master Code 3 Installer Code 4Partition Supervisor (aka Partition Master) 5 Normal User (aka Standard)6 Guest User 7 Duress Code - Causes a Duress Alarm when this code isused for this Partition. (Normally a User tagged Duress wouldn't haveother tags.) 8 Arm Only - This user can only arm, not disarm/bypass thepartition. 9-255 Reserved12.4.3 PIN Code

Many Remote Commands require a PIN code to be properly executed. The PINCode object is used to pass this Code to the Command, usually as part ofan Extension (8.2.1) of the initial object.

Offset Size Name Discussion 0 1 PIN Length (P) 1 P PIN UTF-8 Digits12.5 CMS Channel

CMS Channel objects configure where a panel should attempt to send AlarmReports, and how those alarm reports should be sent.

Offset Size Name Discussion 0 1 CMS Channel Number Channel ID 1 1Channel Lower number means higher priority Priority 2 2 Timeout Timeoutin seconds before a transmission on this channel is considered failed 41 Retry Number of failed retries on this channel before moving to nextpriority channel 5 1 Report Type (See 12.5.1) 6 1 Transport (See 12.5.2)Type 7 1 Server Path Size (S) 8 S Server Path (See 12.5.3) Data12.5.1 CMS Report Type

Value Meaning 0 Unknown 1 CCID 2 SIA 3-255 Reserved12.5.2 CMS Transport Type

Value Meaning 0 Unknown 1 Broadband - TCP 2 Broadband - UDP 3 Cellular -UDP 4 Cellular - SMS 5 Cellular - TCP 6 POTS 7-255 Reserved12.5.3 CMS Server Path

CMS server configurations are likely to vary from panel to panel, so theformat of this configuration string is Device specific. It should alwaysbe parsable as a UTF-8 string. It is expected to contain APNconfiguration, Server IP:Port, Additional CMS configuration settings,CMS Phone number, or similar configuration based on the Transport Typeand Panel details.

12.6 System Trouble Object

Troubles are issues with the Panel's hardware. There may be multipletroubles active on the panel at once, and they need to be reportedseparately from the overall panel configuration, partition and zonestates.

Offset Size Name Discussion 0 1 Trouble Count (T) Number of SystemTrouble codes to follow. Count of Zero (0) means no troubles. 1 1 SystemTrouble 1 Enumeration, See 12.6.1 2 1 System Trouble 2 3 1 . . . 1 + T 1System Trouble T.12.6.1 System Trouble Enumeration

Each active Trouble in the Panel is reported in a single byte, where theleast significant 7 bits come from the following enumeration. The mostsignificant bit is set to 1 if the condition is true and to 0 if thecondition is false. Usually, only active Troubles are reported, so theMSB would only normally be set to 0 in an Async even indicating theTrouble had resolved itself. These are events that apply to the systemas a whole as opposed to an individual zone or partition. This statusshould not be used to report similar troubles (such as Low Battery) fromzone devices, that status is reported in a zone status report.

Value Meaning 0 Noop -- Not Used 1 Trouble: Low Battery 2 Trouble: ACFail (i.e. AC power loss) 3 Trouble: Tamper 4 Trouble: Telephone LineFailure 5 Trouble: Cellular Radio Failure 6 Trouble: RF Jam 7 Trouble:Siren Failure 8 Trouble: Watchdog Restart 9 Trouble: Other (See Keypad)10 Trouble: Hardwire 11 Trouble: Ground Fault 12 Trouble: Device Fail(deprecated - use Supervisory, 14) 13 Trouble: Ethernet Failure 14Trouble: Supervisory (Panel or Device Absent) 15 Firmware Update InProgress 16 Communications Trouble (FTC) 17 Bus Trouble 18-99 Reservedfor other system trouble conditions. 100 Forced bypass enabled 101-255Reserved.12.7 Panel Event Queue

Many panels have an internal event queue, with a panel specific format,timestamping, etc, that may include more specific data or event typesthat aren't reported by SMA. SMA allows these event objects to bequeried for panel specific debugging.

The Panel event queue is queried using the “Get Panel Event Queue Info”Command of Capability 2 (Panel Configuration.) This command returns aPanel Event Queue Info Object. The server can then ask for informationon specific events using the “Get Opaque Panel Event” Command.

12.7.1 Opaque Panel Event Object

This is an arbitrary, panel specific blob of binary data about an eventin the Panel.

Offset Size Name Discussion 0 2 Data Size (D) Number of bytes in theData field. 2 D Event Data Arbitrary binary object representing an eventon the Panel.12.7.2 Panel Event Queue Info Object

Offset Size Name Discussion 0 2 Queue Total Number of events the queuecan hold Size 2 2 Queue Number of valid events currently in the queue.Count 4 2 Current Index of the most recent valid event in the Indexqueue. (Queue Indices start at 0, up to (Queue Size) − 1.) 6 1 Grows 0 -Queue grows “down” - later events have Up lower indices. 1 - Queue grows“up” - later events have higher indices. 7 1 Wraps 0 - Queue does notwrap. 1 - Queue indices wrap, index (Queue Size) is one higher than 0,etc.13 Partition Objects

Partitions are a central object type, used to track a subset of thepanel which can be armed and disarmed separately. Each Partition has aset of sensor Zones assigned to it, and a Zone can only be assigned to asingle Partition. Most actions a user performs are done on a partition,or some sub-object of a partition. The Partition object contains overallconfiguration information for the Partition, while the specific state isreflected in separate sets of objects tied to the Partition ID:

-   -   An Arm State object    -   A Partition Mode object    -   Active Alarm objects    -   Zones (include Zone State and Zone Config objects)        13.1 Partition ID—Zero is reserved

Like most persistent configuration objects in the system, Partitionshave unique IDs to track references to them from other objects. As withother IDs, no Partition should be assigned ID 255/0xff, as that is usedto indicate an unknown or uninitialized value. However, Partition ID 0is also reserved. Depending on panel implementation, Partition 0 mayinclude an Alarm list for Panel-wide events such as RF jamming.

13.2 Partition Config Object

Offset Size Name Discussion 0 1 Partition ID Partition Number 1 1Partition Type Partition Type (Normal, Shared, etc) See 13.2.1 4 2 EntryDelay 1 First Entry Delay in Seconds 6 2 Exit Delay Exit Delay inSeconds 8 2 Entry Delay 2 Second Entry Delay in Seconds 10 1 Name Length(N) Length of Partition Name field 11 N Partition Name UTF-8 Encoded13.2.1 Partition Type Enumeration

This is a simple enumeration, mostly for future extensibility.

Value Meaning 0 Standard Partition 1 Shared or Common Partition 2-254Reserved 255  Unknown/Unassigned.13.2.2 Arm State Object

The partition's Arm State is changed regularly during normal paneloperation, and is not considered part of the Partition's persistentconfiguration.

Offset Size Name Discussion 0 1 Partition ID Partition Number 1 1 ArmState Arm State Enumeration. See 13.2.3 2 2 Entry/Exit Delay Millisecondremaining in the Entry/ Remaining Exit Delay.13.2.3 Arm State Enumeration

The arm state byte is divided into four fields:

7 6 5 4 3 2 1 0 In Exit Arming In Entry Arm state from the followingtable. Delay Allowed Delay

The lower 5 bits of the arm state is mapped to one of these values. Thissame enumeration is used whether the arm state is being sent from theserver to the CPE (i.e. a “command”) or whether it is sent from the CPEto the server in a status or event report. The server will always setthe upper three bits to zero when it sends a set arm state command.

The upper three bits are an adjunct to the enum. They should only be setby the SMA client based on the partition state. All Set Alarm Statecommands from the server should set these three bits to 0, and theclient can ignore them in all Arm commands. The “in exit delay” bitshould only accompany an Arm state, while it is ignoring Zone eventsduring its exit delay. Similarly, “in Entry Delay” should be set whilethe partition is ignoring (some) zone events during the Entry Delay.Finally, the “arming allowed” bit MUST be set if the system is in astate where it can be armed, and MUST be cleared if the system cannotaccept an arm command at this time (i.e. there are outstanding troublesor alarms that must be cleared or acknowledged, or zones that must beclosed or bypassed.)

Value Meaning  0 Disarmed/disarm/off/clear  1 Reserved.  2-9 ReservedNon-Armed States 10 Armed Away 11 Armed Stay 12 Armed Night 13 ArmedAway - No Auto Stay 14 Arm Motions 15 Subdisarmed 16 Armed Away Instant(No Entry Delay) 17 Armed Stay Instant (No Entry Delay) 18 Armed NightInstant (No Entry Delay) 19-31 Reserved Armed States13.2.4 Partition Mode Object

A partition can be put into other operational states independent of itsArm/Disarm status. The Partition Mode object is used to describe thosestates. As with Arm State, these are expected to change regularly aspart of normal operation, and so are not considered part of thePartition's persistent configuration.

Offset Size Name Discussion 0 1 Partition ID Partition Number 1 1Partition Mode Partition Mode(s) See 13.2.513.2.5 Partition Mode Enumeration

This bitfield is used to reflect information about the partition stateseparate from Arm/Disarm. Each Mode can change independent from theother, and from Arm state, although certain Mode+Arm State combinationsmay be impossible (Disarmed+Quick Exit, for example.)

Bit Meaning 0 Chime Mode - Chime on Sensor Open/Close for Sensors markedChime-able 1 Quick Exit - The Partition is in Quick Exit mode, allowingfor brief exits without Disarming. 2 Reserved 3 Reserved 4 Reserved 5Reserved 6 Reserved 7 Reserved14 Alarms

Alarms are always reported on a particular partition, as they are tiedto that Partition's Arm state. Any change in the alarm or arm statesmust be reported immediately. Whenever an alarm gets triggered orcleared, the CPE must send a message with zone status reports for all ofthe zones involved in the alarm. The CPE should send both a Zone Statuschange event and an Alarm event. The SMA server does not assume that azone going into or out of Alarm state implies that the Partition hasstarted or cleared an Alarm.

A typical sequence of events reported during arming would be:

-   1. Arm state changes from “Disarmed” to Arm-Away(ExitDelay)-   2. Exit door shows fault.-   3. Exit door fault is cleared.-   4. After the exit delay expires, arm state changes to Arm-Away

A typical sequence of event reports when the system is disarmed afterentry:

-   1. Entry door shows fault-   2. Immediately, the Arm state changes to Arm-Away(EntryDelay)-   3. Entry door fault is cleared (optional)-   4. User clears the alarm, so the Arm state changes to “Disarmed”.

In the case of a “break in”, the alarm sequence of events is:

-   1. Entry door Zone opens and reports an Async Zone Status event.-   2. Immediately, the Arm state changes to Arm-Away (EntryDelay)-   3. Entry door fault is cleared (optional)-   4. After the entry delay expires, the faulted zone sends a Zone    Report Async event, reflecting it's “alarm” report is sent-   5. An Alarm Report Async Event is sent for the Partition, with    reporting status.    14.1 Alarm Objects

Alarm objects provide information about active alarms on the partition.There may be multiple alarms active on the same partition at the sametime. In addition to being tied to a partition, they are identifiedwith:

-   -   Alarm type (fire, motion, panic, duress, etc)    -   Source type (Zone, User, or Unknown)    -   Source Identifier (A Zone or User Index, or Unknown)    -   Reporting status, including channel, time, and report state

Offset Size Name Discussion 0 1 Alarm/Response The response determineswhich alarm Type type is reported. See 14.1.1 1 1 Partition ID Partitionreporting this Alarm. 2 1 Source Type Alarm Source Enumeration, See14.1.2 3 2 Source ID Zone ID, Controller + User ID, or Trouble. Dependson Source Type, See 14.1.2 5 6 Timestamp Time this Alarm started.14.1.1 Alarm/Response Type Enumeration

The alarm/response type is a 1-byte enumeration mapped to one of thesevalues. Every zone must be associated with one of these values. This isthe value that is returned in response to a “Get Zone Configuration”request (see appendix G). In this way, once the server knows how eachzone is configured, it can properly handle alarm reports, either singlyor in combination, by examining the zone status.

In some cases, depending on the CPE, some alarms can be reported whichare not associated with a zone. Those alarms are reported using the“Misc Alarm” report type instead of the zone report. The reason is that,whereas the server already knows all about a zone and only needs asingle “alarm” bit in the report, non-zone alarms must supply the alarmsource and the alarm type (from this table) in the alarm event. The“Misc Alarm” report is similar to the “Misc Status” report in that thelower 7 bits represent the alarm type, while the most-significant bit isa flag indicating whether the alarm is on or off.

Once a “Misc Alarm” has been sent as “on”, it must be cleared when thatalarm is no longer true. (This is exactly the same as for zonealarms—each alarm report requires a clear report to keep things insync.) Ordinarily, this is accomplished by sending one clear event foreach alarm that's been sent. However, to accommodate CPEs that clear allalarms simultaneously, such a CPE can send the “no alarm” message. Theserver will interpret any “Misc Alarm” event of“no alarm” type asindicating that all “Misc Alarms” have been cleared.

Response types are grouped into three categories based on how theybehave when faults occur. “Standard” responses trigger an alarm if thepanel (partition) is armed at the time of the fault. Responses withindexes between 1 and 31 are standard alarms. 24-Hr Audible (“Loud”)alarms are generated even if the panel is not armed, and as their nameimplies they make a loud sound (siren, alarm bell, etc) when they aretriggered. Examples include CO, fire and some panic alarms. These alarmshave indexes between 32 and 63. 24-Hr Silent (“Stealth”) alarms (indexes64-95) similarly generate an alarm whether or not the panel is armed,but they are silent so as not to alert the intruder. Examples includeduress and silent panic alarms. Panel Responses cause some action to betaken on the panel, but do not cause alarm reports. These events haveindexes between 96 and 127.

Value Meaning Discussion  0 Not Used This zone shouldn't really beconsidered part of the system. Used for Zones that haven't been fullyconfigured or installed.  1 General Burglary Used for a Burglary Alarmthat is not generated by a more specific Response type.  2 Exit FaultExit Fault Alarm.  3 Perimeter Always causes an instant Alarm (ignoringentry delay while the partition is Armed in any mode.  4 Entry/ExitDelay 1 When tripped, starts the Entry delay (duration defined byConfigurable Entry Delay 1) if the partition is armed to a mode with anEntry Delay and the Exit Delay has expired. Once tripped, causes anAlarm if the system is not disarmed after Entry Delay 1. If partitionarmed to a mode with No Entry Delay, causes an instant Burglary Alarmwhen tripped.  5 Entry/Exit Delay 2 When tripped, starts the Entry delay(duration defined by Configurable Entry Delay 2) if the partition isarmed to a mode with an Entry Delay and the Exit Delay has expired. Oncetripped, causes an Alarm if the system is not disarmed after Entry Delay2. If partition armed to a mode with No Entry Delay, causes an instantBurglary Alarm when tripped.  6 Interior Delay 1 When tripped, startsthe Entry delay (duration defined by Configurable Entry Delay 1) if thepartition is armed Away with Entry Delay enabled, and the Exit Delay hasexpired. Once tripped, causes an Alarm if the system is not disarmedafter Entry Delay 1. If partition armed to Away with No Entry Delay,causes an instant Burglary Alarm when tripped. No Action if trippedwhile Armed Stay or Night.  7 Interior Delay 2 When tripped, starts theEntry delay (duration defined by Configurable Entry Delay 1) if thepartition is armed Away with Entry Delay enabled, and the Exit Delay hasexpired. Once tripped, causes an Alarm if the system is not disarmedafter Entry Delay 1. If partition armed to Away with No Entry Delay,causes an instant Burglary Alarm when tripped. No Action if trippedwhile Armed Stay or Night.  8 Interior Follower The panel will send anAlarm when this zone is tripped while the system is armed Away. If thepanel is in entry delay, tripping this zone will not cause an alarm. Noaction if tripped while Armed Stay or Night.  9 Alarm or Trouble AkaDay/Night. Always causes an Alarm while the system is armed in any mode.While the system is disarmed, causes (and possibly reports) a paneltrouble. 10 Monitor Zone has no alarm response. Similar to “No AlarmResponse”, but some panels assign slightly different behavior to zoneswith this response type. 11 No Alarm Response This zone is configured tohave no alarm response. 12 Night Follower The panel will send an Alarmwhen this zone is tripped while the system is armed Night. If the panelis in entry delay, tripping this zone will not cause an alarm. No actionif tripped while Armed Stay or Away. 13 Night Interior Delay 1 Whentripped, starts the Entry delay (duration defined by Configurable EntryDelay 1) if the partition is armed Night with Entry Delay enabled, andthe Exit Delay has expired. Once tripped, causes an Alarm if the systemis not disarmed after Entry Delay 1. If partition armed to Night with NoEntry Delay, causes an instant Burglary Alarm when tripped. No Action iftripped while Armed Stay or Away. 14 Night Interior Delay 2 Whentripped, starts the Entry delay (duration defined by Configurable EntryDelay 2) if the partition is armed Night with Entry Delay enabled, andthe Exit Delay has expired. Once tripped, causes an Alarm if the systemis not disarmed after Entry Delay 2. If partition armed to Night with NoEntry Delay, causes an instant Burglary Alarm when tripped. No Action iftripped while Armed Stay or Away. 15 Trouble Panel reports trouble forthis zone when it is tripped. No alarm. 16-31 Reserved 32 CO Alarm(Without Carbon Monoxide detectors. Verification) 33 Fire Alarm (WithoutFire/smoke/heat detectors. Verification) 34 Police Alarm 24-hour AudiblePanic Alarm. 35 Temperature Alarm For high/low temperature sensors - NOTHeat Sensors that detect fires. This is a type of 24-hour auxiliaryalarm. 36 Freeze Alarm Freeze sensors. This is a type of 24-hourauxiliary alarm. 37 Water Alarm Water/flood sensors. This is a type of24-hour auxiliary alarm. 38 Aux Alarm Personal Emergency Alarm. 39Tamper Alarm Any device or system-module tamper that causes a tamperalarm. 40 Gas Alarm (including 24 Hour Gas). Note: this is for detectinggas that is not CO. 41 Waterflow Alarm For Sprinkler/Waterflow sensors,to detect when the sprinkler system is engaged. (Different from Water)42 General Alarm (including Supervisory Buzzer) For alarms that don'teasily align with any of the other specific types. 43 Fire Alarm withThis alarm must be verified before being reported. Verification AnotherFire w/Verification zone tripping, or this Zone continuing to betripped, within a configurable timeout, verify the alarm. 44-63 Other24-Hr Audible Alarms 64 Duress Alarm Duress code entered. 65 Aux SilentAlarm Silent personal emergency alarm 66 Police Silent Alarm 24-hourSilent Panic Alarm. 67 General Silent Alarm (including SupervisorySilent) 68 Silent Burglary Alarm Instant silent alarm when armed in Stayor Away mode (with or without Entry Delay). 69-95 Other 24-Hr SilentAlarms 96 Arm Away The Partition should be armed Away when this zonetrips. Typically used for keyfob button zones. 97 Arm Stay The Partitionshould be armed Stay when this zone trips. Typically used for keyfobbutton zones. 98 Disarm The Partition should be disarmed when this zonetrips. Typically used for keyfob button zones. 99 Arm Night ThePartition should be armed Night when this zone trips. Typically used forkeyfob button zones. 100-127 Reserved for Future Panel Actions 128-255Reserved for Future Expansion14.1.2 Event Source

This enumeration identifies what or who in the system caused and event.Events are caused by a Zone, System Trouble, or User action.

Value Meaning 0 Unknown. Ignore Source ID 1 Zone, Source ID is a Zone ID2 User Action: The first byte of Source ID is a Controller ID. (0xff ifunknown) The second byte of Source ID is a User ID. (0xff if unknown) 3System Trouble The first byte of Source ID is the System Trouble code(12.6.1) The second byte is 0. 4-255 Reserved.15 Zones

Zones reflect various types of sensors attached to this partition. ZoneIDs are shared across all partitions in the system. Zones will oftenonly be included in single Paritions, but the protocol provides forZones that are included in multiple Partitions. Zones are identified by:

-   -   Zone Index or ID (Unique)    -   A Zone Config object describing the persistent configuration of        the Zone.    -   A Zone Status object describing the current state of the Zone.        15.1 Zone Config Object

Offset Size Name Discussion 0 2 Zone ID 2 1 Response Type The type ofaction taken when this zone is tripped. See 14.1.1 3 1 Hardware Type See15.1.1 4 1 Zone Group Defines various attributes of the zone. See 15.1.25 1 Partition Count (P) Number of Partitions this Zone is part of. 6 PPartition ID 1 Partition IDs for each Partition this Zone is in. throughP 6 + P 1 Name Size (N) Number of bytes (NOT characters) in displayname. 8 N Name Name, UTF-8 encoded.15.1.1 Hardware Type Enumeration

The hardware type field of the zone configuration report. This samehardware type is also used in the “Misc Alarm” event report to indicatewhat triggered the alarm in cases where the trigger is not a zone.

Value Meaning Discussion  0 Unknown.  1 Standard Sensor. Use if morespecific hardware type is not known.  2 Alarm Panel Key(s) I.e. keypademergency/panic buttons 3-9 Reserved 10 Unspecified Keyfob Keychainremote 11-20 Keyfobs for users 1-10 21 Door/Window Sensor For panelsthat don't support separate types for Door and Window 22 Freeze Sensor23 Temperature Sensor 24 Motion Sensor 25 Fire/Smoke/Heat Sensor Usedfor general fire detection sensor, including ones that include BOTHsmoke & heat sensors. See separate Smoke Sensor & Heat Sensor types forpanels that can further distinguish those. 26 Pressure Sensor 27 COSensor 28 Glass Break Sensor 29 Water Sensor Water/flood 30 KeypadRemote 31 Panic Button Single-button remote 32 Gas Sensor 33 ShockSensor 34 Local Annunciator (Siren) 35 System/Supervisory Zone 36Sprinkler/Water flow Sensor 37 Tamper Sensor 38 Door Sensor When panelcan distinguish specifically that the zone is for a door vs. a window -else use Door/Window Sensor 39 Window Sensor When panel can distinguishspecifically that the zone is for a door vs. a window - else useDoor/Window Sensor 40 Smoke Sensor When panel can distinguishspecifically that the zone is for a smoke detector (not heat detector ora combo device) - else use Fire/Smoke/Heat Sensor 41 Heat Sensor Whenpanel can distinguish specifically that the zone is for a heat detector(not heat detector or a combo device) - else use Fire/Smoke/Heat Sensor42 Environmental Sensor General purpose when none of the more specificones are a good fit  43-128 Reserved 129  Simple Lamp 130  Dimmer Lamp131-254 Reserved15.1.2 Zone Group Enumeration

Zones may also be configured into groups to control their interactionwith various panel features, independent of their hardware type. Often,these Groups will interact with certain panel features or Modes toconfigure specific functionality. This bitfield defines 8 potentialgroups; a zone can be placed into any or all of them. When a zone ispart of a specific group, that is another way of saying that it has the“attributes” of that group.

Bit Meaning Discussion 0 Chime-able Zones in this group should cause achime when Opened/Closed, if the Partition is in Chime Mode (See 13.2.2)1 Supervised This zone should cause a supervisory report/alarm if it'snot seen by the panel within a configurable timeout. 2 Bypass Group Thiszone should be bypassed or unbypassed as part of the Bypass Group forthis partition. 3 Auto-Bypass Aka “Vent Zone”. System can be armed ifzone is tripped. While the system remains armed, if the zone issubsequently closed and then tripped again, the behavior is determinedas follows: If the zone is also in the Auto Unbypass On Normal group(see next item), then an alarm will occur Otherwise, no alarm occurs(all additional zone trips will not cause an alarm during the currentarming period) 4 Auto Unbypass Aka “Vent Re-Arm”. Only applicable tozones On Normal that are also in the Auto-Bypass group. See Auto-Bypassdescription for details. 5 Alarm Report 6 Reserved 7 Reserved15.2 Zone Reporting

While the rarer zone-related events (low battery, tamper, etc) arealways reported in real time, zone fault events that do not trigger analarm are treated differently. How these routine events are treateddepends on how the zone is configured to report. Each zone is assigned aReport State in its Zone Config object (See 15.1 and 15.2)

15.2.1 Zone Reporting Object

Each SMA session needs to be able to control the stream of zone reportscoming from the CPE. Zone reporting objects are used to configurereporting state for each Zone, even if the connection would not normallysupport other kinds of Zone Configuration.

Offset Size Name Discussion 0 2 Zone ID 2 1 Zone Report See 15.2.2Enumeration15.2.2 Zone Report Enumeration

The Zone Reporting field of Zone Config describes whether events on thisZone should be reported immediately, or be queued up with other ZoneStatus events.

Bit Meaning 0 Report all events: 0—Mask Faults 1—Report all events 1Report Immediate 0—Report When Convenient 1—Report Immediate1. Faults Masked

Routine, non-alarm faults on a masked zone are never reported. Alarm andvarious trouble conditions (battery, tamper, etc.) are always reported.This type of reporting status is typically applied to motion sensors,but could be applied to any zone type. Support for this reporting typeis MANDATORY.

2. Report Immediate

Events on zones marked “report immediate” are always reported when theyoccur. If any non-immediate events are queued up, they are sent alongwith the immediate report. If queued events are sent, they MUST be inproper temporal order. Support for this reporting type is alsoMANDATORY.

3. Report when Convenient

Zones which aren't marked Report Immediate are considered “report whenconvenient.” If the CPE is capable of queuing up events, faults on zonesmarked this way SHOULD be queued up until its “convenient” to reportthem. Note that these MUST be reported eventually. “Convenient” in thiscontext means:

-   -   a. along with an immediate-type report,    -   b. when the CPE's event queue is filled,    -   c. after a configured cache-flush period,    -   d. immediately if the CPE does not support an event queue,    -   e. immediately whenever a remote control session is open or,    -   f. immediately if any partitions associated with the zone is        armed.

Support for this type of reporting state is implicit, given that a CPEis always allowed to send this type of event immediately. However, inorder to drastically reduce the number of message and overall bandwidthrequired for event reporting, CPE designers are highly encouraged toqueue these non-essential events if possible.

15.3 Zone Status Object

Offset Size Name Discussion 0 2 Zone ID 2 1 Zone State See 15.3.115.3.1 Zone State Enumeration

The zone status is reported as a bitmap with the following meanings. Allbits must be valid in every report. In other words, this bitmap mustrepresent the current state of the zone. For example, as long as a zonehas a low battery condition, bit 3 must be set in every report sent, nomatter what change triggered the event to be sent.

This encoding is used for both asynchronous zone event reports and inresponses to a zone status request.

Bit Meaning 0 Alarm: 1 = causing an alarm 1 Fault: 0 = not fault, 1 =fault 2 Tamper: 1 = tampered 3 Battery: 1 = low battery 4 Supervision: 1= failed supervision 5 Misc Trouble: 1 = trouble 6 Bypassed, 1 =currently bypassed 7 Reserved.15.4 Zone Learning

Most Add/Change/Remove commands are fairly self explanatory, as theyrefer only to the internal configuration state of the Panel. Adding Zoneis more complicated, as it involves discovering the external sensorhardware, telling that hardware to pair with the Panel, and reportingthat potential new Zone to the SMA server for addition. This process iscalled Zone Learning, and is intended to be compatible with a broadrange of Panels.

Zone learning is initiated by the SMA server, for a particularPartition, using the Enter Zone Learn Mode Command (Value 3, See10.4.3). This command may return a message specific error code from thefollowing table, in addition to the normal Command Error codes fromSection 17

Value Meaning 128 Already in Learn Mode for a different Partition 129Already in Learn Mode for this Partition 130 Can't enter Learn Mode fromthis Arm State. 131-255 Reserved

If the Enter Zone Learn Command succeeds, the Panel will send a “ZoneLearn Mode Entered” Async event. This will indicate that the panel is ina state to detect and add new Sensor Zones.

When the Panel successfully detects a new sensor being added (usingwhatever Panel specific process are require to trip/pair the sensor) itwill send a “Zone Learn Detected” Async event to the SMA server. Thisevent will include a Zone Config object for the newly discovered Sensor.This object indicates the provisional Zone ID allocated for the newSensor, as well as the hardware type and other attributes learned fromthe sensor detection. This Zone ID will only be valid until the serveraccepts or rejects the new Zone.

The SMA server can now choose to either Accept or Reject the new Zone bysending the Zone ID object in a “Zone Learn Accept (Capability 2, Type3)” or “Zone Learn Reject (Capability 2, Type 4)” command. If the Zoneis accepted, the Panel should send a “Zone Added” Async event, and theZone will now be listed as part of the configuration. This should alsocause a “Config Change” event to be send to inform all Capability 1devices to update their sensor lists. If the new Zone is rejected, thesensor will be returned to its unlearned state, and the Panel will senda “Zone Learn Rejected” Async event. The provisional Zone ID will bepurged, and may be allocated again to a newly learned/added Zone.

This process may be repeated as needed. Once the Server is finished withall Zone Learning, it sends the “Exit Zone Learn Mode” command. ThePanel responds with a “Zone Learn Mode Exited” Async event Some panelsmay have an automatic timeout of Zone Learning Mode, or automaticallyleave this mode after a sensor has been detected. These Panels shouldsend the “Zone Learn Mode Exited” Async event in that case, without acorresponding “Exit Learn Zone Mode” Command.

15.4.1 Zone Serial Number Object

Once a Zone has been learned, it will occasionally need to be added to aPartition explicitly. For instance, after the Panel has completed afirmware upgrade, it may need to restore its device configuration viaSMA. Rather than repeating the Zone Learning process, most Panelsprovide a mechanism for adding a Zone based on a unique identifier,called the Zone Serial Number. The Serial Number data is entirelyPanel/Vendor specific. The only requirement is that a Zone Serial Numberreturned from a Get Zone Serial Number Query can be used to later re-addthat Zone using the Add Zone By Serial Number Command.

Offset Size Name Discussion 0 1 Partition ID Specifies the Partition IDto add the Zone to for Add Zone By Serial Number 1 2 Zone ID Zone ID forthis Serial Number. Set to 0xff during Add Zone By Serial Number 3 1Serial Size (S) Size in Bytes of the Serial Number 4 S Serial NumberBytes specifying a Unique Zone Sensor16 Monitor/Control Devices

Monitor/control (“m/c”) devices such as lights, locks, etc are treated,for the most part, identically to zones. While not technically a zone,each device must be assigned a unique zone number, and uses the zonenumber as a “key” in both commands and status reports. The maindistinctions between zones and m/c devices are:

-   -   1. Status reports, both synchronous and asynchronous, have a        different format to accommodate the additional information        available.    -   2. Precise definition of the meaning of the m/c status reports        is outside the scope of this document. Instead, the protocol        allows for variable-size data in both commands and reports.

As with zones, the configuration of monitor/control devices is not partof this protocol (which simply provides ongoing monitor and controlcapability). The CPE must be completely configured in all respects priorto using this protocol. The only configuration command ever sent by theserver through this protocol is the CPE interface configuration(appendix J)

16.1 M/C Command Object

Offset Size Details 0 2 Zone ID (0-65535) 2 1 Size in bytes of commanddata. 3+ Variable Command data (See specific device type for details).16.2 M/C Report Object

Offset Size Details 0 2 Zone ID (0-65535) 2 1 Size in bytes of devicedata. 3+ Variable Device status data (See specific device type fordetails).17 Error Code Enumeration

If the panel encounters an error in executing a remote command, itshould set the Error Code field in the Remote Response payload. An errorcode of 0 indicates success. Error codes below 128 are shared betweenall messages in the system. Some shared codes only relate to specificcommands/actions (arming) for legacy reasons. Codes of 128 and above arespecific to the Request or Event type.

Value Meaning 0 No Error (Command succeeded as expected). 1 Invalid PIN2 Can't arm (unbypassed zone(s) open) 3 Can't arm (already armed) 4Panel Busy (try again later). 6 Panel in wrong state for operation 7Can't bypass one or more zones 8 Not implemented 9 UnsupportedCapability 10 General Permission violation (This user does not havepermission for this action on this Partition.) 11 Dealer Permissionviolation (This action requires the Dealer PIN) 12 Installer Permissionviolation (This action requires the Installer PIN) 13 Master Pennissionviolation (This action requires the Master PIN) 14 Supervisor violation(This action requires a Supervisor Permission on this partition.) 15Downloader Action in progress. 16 Firmware upgrade in progress. 17Attempt to change a fixed configuration value. (Panel Vendor, ZonehwType, etc.) 18 Installer Mode - Operation in progress. 19Configuration error - Parameter out of range. 20 Parameter error -Parameter of a command is the wrong object type, or has other parsingerrors (too short, string length mismatch, etc.) 21 Data not Available -Data requested in a Query is no longer available. 22 Configuration DataOverwrite - The command is attempting to modify data that is fixed, oralready allocated (such as adding an object with an already used Index,which should be changed with an Edit command instead.) 23-98 Reserved.99 Unexpected Error (an internal panel error) 100-127 Reserved 128-255Message Specific Error Code.18 Downloading and Programming

Many panels have additional, panel specific mechanisms for storing,managing, and downloading complete sets of configuration information.These Downloading operations are usually driven by a vendor specificServer/Program called a downloader. SMA needs to both synchronize with,and drive these Downloader operations.

Panel software/firmware can also often be upgraded remotely. Many times,the SMA server is the primary pathway for such Firmware Upgrades.

Firmware formats and Downloader configuration are all very panel andvendor specific. SMA provides simple mechanisms for setting andretrieving general configuration for both the Downloading andProgramming, driving generic actions and receiving status updates fromeach.

In addition to the Async Events for Download and Programming, the Panelshould send Async events updating the Panel Mode (12.1.1) to indicatewhen these events happen:

-   -   2. The Panel Configuration is invalidated (Panel Mode 6        “Downloader, Configuration Invalid” or 7 “Programming,        Configuration Invalid”. Entering this state tells the SMA server        that the panel is not accepting normal operations, and its        configuration is in an indeterminate state. The SMA server will        not assume that any configuration beyond CPE and Panel        Vendor/Model information will persists after this Mode is        indicated. This Mode should be used for major changes to the        Zone, Partition, User and other configuration lists. This mode        change is reported to eliminate the need to send a whole series        of Async Events to reflect removing every Zone, Permission,        User, and Partition in the system. Minor changes should send        specific Async Events for each configuration change.    -   3. The Panel Configuration has been reset. (Panel Mode 8        “Factory Reset.”) The Panel Configuration has been completely        wiped. If the SMA server is managing a persistent configuration        for this deployment, the server can being to set up the correct        configuration on recognition of this Mode.    -   4. The Panel Configuration has been set (Panel Mode 9 “Download        Configuration Completed.” A new Panel configuration has been set        by the Downloader, and the SMA server should being updating its        configuration using the normal Queries.

Appendix A. AES/CBC-256 with Initialization Vector

The default encryption method uses the Advanced Encryption Standard witha 256 bit (32-byte) key, seeded by an initialization vector (128 bits/16bytes), with Cypher Block Chaining. Details, libraries and code for thismethod are readily available.

AES-256 requires a shared 32-byte key which must be distributedout-of-band. How this key is distributed is outside the scope of thisspecification.

The initialization vector is a 16-byte array composed of the 6 bytes ofthe header timestamp repeated twice followed by the 4 most significantbytes of the timestamp. For example:

-   -   TS bytes: 00 01 02 03 04 05    -   Corresponding IV: 00 01 02 03 04 05 00 01 02 03 04 05 00 01 02        03

When data length is a multiple of the block size (16 bytes) then paddingis increased by 1 additional block.

Appendix B. CPE Interface Configuration

CPE interface configuration strings are used by older versions of theprotocol, on more restricted devices, to do much of the configurationdone through CMS Channel objects currently. They are included here as areference.

The interface configuration is sent either as a standard remote controlrequest or via an SMS message. Its primary purpose is to set the serveraddresses and the event reporting parameters. This message is sent astext that defines a number of configuration properties as name=valuepairs. The CPE MUST validate that the config key sent in the messagematches the CPE's key.

If the key sent in the message is wrong, the CPE simply ignores themessage.

When sent over a Remote Control channel rather than directly via SMS,the SMS is encapsulated in a Config String object.

Offset Size Name Discussion 0 2 Contig String Length in bytes of theConfig String Length (S) 2 S Config String UTF-8 encoded string,matching the SMS string format below.

The CPE returns a similar Config String object in response to a “GetInterface Config”.

Common Properties

Field Property ID Description Example Header header Constant preamble“ICCFG” CPE Config Key k Usually the MAC address, but can be 1201345678dynamically created out-of-band if the CPE supports it. Security Key skIf a shared AES security key is in TBD place, this will be set based onthe key and a proprietary algorithm shared between iControl and the CPEvendor. APN1 Server s1 Server address to use when 192.168.1.16 Addresscommunicating over the primary APN. APN1 RC Server rc1 Server port forremote control 11611= Port connections. APN1 Event Server ev1 Serverport for event reports. 11612 Port APN2 Server s2 Server address to usewhen 192.168.2.16 Address communicating over the secondary APN. APN2 RCServer rc2 Server port for remote control 11613 Port connections. APN2Event Server ev2 Server port for event reports. 11614 Port RetryIntervals rt Event report retry intervals, in 10 10 20 30 . . . seconds.“ . . . ” indicates the end of the list, and that the preceding intervalshould be used until the retry time expires. Retry Timeout How long totry before giving up and 86400 (24 discarding the event report. hours)Cache Expiration cx How long to cache non-essential 86400 (24 events.hours) TCP Keepalive ka Maximum rate at which to check 120 (2 TCPconnection during a remote minutes) ontrol session. Set to zero for nokeep-alives. Security Key sk If a shared AES security key is inDetermined by place, this will be set based on the iControl and key anda proprietary algorithm CPE vendor, shared between iControl and the CPEbased on CPE vendor. capabilities. Expiration ts Hex representation of a6-byte 010203040506 Timestamp timestamp after which the SMS should beignored. Client Heartbeat hi Interval in seconds that a non-GSM 30 (30Interval client should send the Asynchronous seconds) Client Heartbeat.Example of an Interface Config Message:

-   ICCFG-   k=010203040506-   s1=192.168.1.16-   rc1=11611-   ev1=11612-   s2=192.168.1.16-   rc2=11613-   ev2=11614-   rt=10 10 15 15 30 30 60 . . . 1800-   ka=120-   cx=86400-   sk-xxxxxuoooooooxx-   ts=010203040506

The very first line contains the string “ICCFG” in order to identify thepurpose of the message. This is included at the beginning of everyconfig file string, whether it is sent via an SMS, as a command from theserver in a remote control session, or as a response to a request to theCPE for interface status.

Each subsequent line begins with the property ID followed by an equalssign and the value associated with the specified property. There must beno spaces before or after the equals sign, nor before the property ID.Everything after the equals sign, up to but not including theend-of-line, are part of the property value. The value itself maycontain spaces, as seen above. Properties may appear in any order—boththe CPE and the server must make no assumptions regarding in what orderthe properties will be present in the config string.

The CPE should simply ignore any properties that it does not support.Additional property types may be added without affecting the protocolversion number. Similarly, any properties that the CPE has stored shouldretain their original value if the configuration message does notcontain a value for them. There is no guarantee that a configurationmessage sent to the CPE will contain all of the values supported by theCPE. The server may well send properties in separate messages. This isespecially true if the configuration is sent via SMS. However, the CPEMUST report ALL of the interface properties that it supports when anInterface Config request is sent to it. (Note that data sent in thisdirection is never sent over SMS, so the SMS character limit does notapply).

Upon receipt of the config message, the CPE must compare the newsettings with its current settings. If they are different, the CPE mustupdate its configuration. If all of the settings sent match the currentsettings, the CPE MUST NOT perform ANY externally-visible state changenor perform any time-consuming tasks such as updating flash, reportingconfig changes to a 3rd party server, etc.

If the config command is received via SMS, once the CPE has handled theconfig message internally (whether or not any changes were made), itMUST initiate a remote control to the server using the newconfiguration. Hence a config SMS that matches the current config istreated exactly like a wakeup SMS.

When the panel finds multiple SMS messages waiting in its queue, onlythe last SMS message in the queue should be processed and the othersshould be ignored and deleted.

The retry intervals shown in the example indicate that the first tworetries (if any) should occur at 10 second intervals, the next two at 15second intervals, another two at 30 second intervals, and subsequentones at 60 second intervals until the retry timeout period has expired(½ hour—1800 seconds—after the first report attempt).

The TCP keepalive time should default to 0 if the panel is able to checkfor SMS messages while a TCP connection is established. If the panel isnot able to check for SMS messages while a TCP connection is establishedthen the keepalive time should default to 120 (2 mins). When thekeepalive time is set, the keepalive interval should match the timesetting and the retry should be set to 5.

If an absolute timeout is required on TCP connection (regardless ofkeepalive or traffic), it should be between 2 and 6 hours.

Heartbeat Interval, with property id “hi” specifies the interval inseconds that a non-GSM client should send a Client HeartbeatAsynchronous Event Message. The default value for this should be 30(seconds). A Client Heartbeat should only be sent after the timespecified by the heartbeat interval has passed since the lastAsynchronous Event Message transmission.

Security Considerations

The config SMS capability is a potential security concern, since it canbe used to “take over” the security panel by modifying the serveraddress. If there is a shared AES key in place, the CPE can check the“sk” property to validate the server. Otherwise, it is recommended thata configuration command sent via SMS only be honored if the panel is ina special mode (e.g. “program” mode) temporarily set by the installerduring installation. In any event, basic security is maintained bykeeping the CPE's (phone number) to MAC address mapping secure. As longas that mapping is secure, the CPE can authenticate the SMS by checkingthat the “k” property matches its own MAC (or whatever permanent key isused).

Appendix C. SMS WAKE Message

The wakeup SMS is sent as text. It contains the following data. The CPEMAY but does not have to validate that the unique ID sent in the SMSmatches the CPE's unique ID. The data format (name=value) is identicalto the configuration command's.

When the panel finds multiple SMS messages waiting in its queue, onlythe last SMS message in the queue should be processed and the othersshould be ignored and deleted.

The panel should not allow more than one simultaneous TCP connection.When a wakeup command is received while an existing TCP connection isunderway, the existing TCP connection should be gracefully terminatedand a new one established. This algorithm is used to address thesituation where the TCP keepalive is set to 0, the connection goes downin a non-graceful manor (eg. no FIN packet received) and the server isattempting to re-establish the TCP connection.

Field Property ID Description Example Header header Standard preamble.“WAKEUP” CPE Unique ID k Usually the MAC address 112233445566 SecurityKey sk If a shared AES security key is in Determined by place, this willbe set based on the iControl and key and a proprietary algorithm CPEvendor, shared between iControl and the based on CPE CPE vendor.capabilities. Expiration ts Hex representation of a 6-byte 010203040506Timestamp timestamp after which the SMS should be ignored.Wakeup SMS Example

-   WAKEUP-   k=010203040506-   sk=xxxxxxxxxxxxxxxx-   ts=010203040506

What is claimed is:
 1. A system comprising: a touchscreen deviceconfigured to communicate with a security system located at a premises;and a security server, located external to the premises, configured to:communicate with the touchscreen device via a first channel associatedwith a first channel type and a second channel associated with a secondchannel type, and communicate data between one or more client devices,located external to the premises, and at least one of the touchscreendevice or the security system.
 2. The system of claim 1, wherein: thesecurity server is configured to transmit, to the touchscreen device andvia at least one of the first channel or the second channel, at leastone of configuration data or initialization data, the configuration datacomprises one or more configuration parameters for the security system,and the initialization data comprises an initialization instruction forat least one security system component of the security system to performan initialization function.
 3. The system of claim 2, wherein the firstchannel comprises a short message service (SMS) channel.
 4. The systemof claim 1, wherein at least one of the first channel or the secondchannel uses a reliable protocol.
 5. The system of claim 4, wherein thereliable protocol is Transmission Control Protocol (TCP).
 6. The systemof claim 4, wherein: the security server is configured to transmit, tothe touchscreen device and via the at least one of the first channel orthe second channel, at least one of command data or request data, thecommand data comprises an instruction to effectuate a state change ofthe security system or a security system component of the securitysystem, and the request data comprises an instruction to transmit, tothe security server, state data indicating a state of the securitysystem or a state of the security system component of the securitysystem.
 7. The system of claim 1, wherein: the first channel uses anunreliable protocol and the second channel uses a reliable protocol, andthe security server is configured to receive, from the touchscreendevice via the first channel and based on request data transmitted tothe touchscreen device via the second channel, state data indicating astate of the security system or a state of a security system componentof the security system.
 8. The system of claim 7, wherein the unreliableprotocol is User Datagram Protocol (UDP).
 9. A method comprising:transmitting, by a security server located external to a premises and toa touchscreen device of a security system located at the premises via afirst channel associated with a first channel type, first data; andreceiving, by the security server from the touchscreen device via asecond channel associated with a second channel type, second dataassociated with the first data.
 10. The method of claim 9, wherein: thefirst channel of the first plurality of channels comprises the SMSchannel, and the first data comprises at least one of a configurationparameter for the security system or an initialization instruction forat least one security system component of the security system to performan initialization function.
 11. The method of claim 10, wherein thefirst channel comprises a short message service (SMS) channel.
 12. Themethod of claim 9, wherein: the first data comprises at least one ofcommand data or request data, the command data comprises an instructionfor the security system to effectuate a state change of the securitysystem or a security system component of the security system, and therequest data comprises an instruction to transmit, to the securityserver, data indicating a state of the security system or a state of asecurity system component of the security system.
 13. The method ofclaim 12, wherein the first channel uses a reliable protocol.
 14. Themethod of claim 13, wherein the reliable protocol is TransmissionControl Protocol (TCP).
 15. The method of claim 9, wherein: the secondchannel uses an unreliable protocol, and the second data indicates astate of the security system or a state of a security system componentof the security system.
 16. The method of claim 15, wherein theunreliable protocol is User Datagram Protocol (UDP).
 17. A devicecomprising: one or more processors; and memory storing instructionsthat, when executed by the one or more processors, cause the device to:transmit, to a touchscreen device of a security system located at apremises via a first channel associated with a first channel type, firstdata; and receive, from the touchscreen device via a second channelassociated with a second channel type, second data associated with thefirst data.
 18. The device of claim 17, wherein: the first datacomprises at least one of a configuration parameter for the securitysystem or an initialization instruction for at least one security systemcomponent of the security system to perform an initialization function.19. The device of claim 18, wherein the first channel comprises a shortmessage service (SMS) channel.
 20. The device of claim 17, wherein: thefirst data comprises at least one of command data or request data, thecommand data comprises an instruction for the security system toeffectuate a state change of the security system or a security systemcomponent of the security system, and the request data comprises aninstruction to transmit data indicating a state of the security systemor a state of the security system component of the security system. 21.The device of claim 20, wherein the first channel uses a reliableprotocol.
 22. The device of claim 21, wherein the reliable protocol isTransmission Control Protocol (TCP).
 23. The device of claim 17,wherein: the second channel uses an unreliable protocol, and the seconddata indicates a state of the security system or a state of a securitysystem component of the security system.